net.praqma.clearcase.ucm.entities

Class Tag

java.lang.Object

net.praqma.clearcase.Cool

net.praqma.clearcase.ClearCase

net.praqma.clearcase.ucm.entities.UCMEntity

net.praqma.clearcase.ucm.entities.Tag

All Implemented Interfaces:

Serializable

public class Tag
extends UCMEntity

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class net.praqma.clearcase.ucm.entities.UCMEntity

UCMEntity.Kind, UCMEntity.LabelStatus

Field Summary

Fields

Modifier and Type	Field and Description
static String	__TAG_NAME The tag name in ClearCase

Fields inherited from class net.praqma.clearcase.ucm.entities.UCMEntity

date, dateFormatter, fqname, kind, labelStatus, loaded, mastership, pattern_std_fqname, pattern_tag_fqname, pattern_version_fqname, pvob, rx_ccdef_allowed, rx_ccdef_cc_name, rx_ccdef_filename, rx_ccdef_vob, shortname, user, vob

Fields inherited from class net.praqma.clearcase.ClearCase

rx_attr_find

Fields inherited from class net.praqma.clearcase.Cool

delim, filesep, filesepChar, linesep, qfs, qfsor

Method Summary

Modifier and Type	Method and Description
static Map<String,String>	CGIToHash(String cgi)
Map<String,String>	GetEntries()
String	getEntry(String key)
static Tag	getTag(UCMEntity entity, String tagType, String tagID, boolean create)
UCMEntity	getTagEntity()
String	getTagID()
static List<Tag>	getTags(UCMEntity entity)
String	getTagType()
void	initialize() initialise the UCM entity.
boolean	isCreated()
Tag	load() Is used by Stringify
static String	mapToCGI(Map<String,String> keyval)
static String	mapToCGI(Map<String,String> keyval, boolean skiptaginfo)
Tag	persist() Persist the Tag.
static Tag	persist(Tag tag)
boolean	queryTag(TagQuery query)
boolean	removeEntry(String key)
void	setCreated(boolean created)
void	setEntry(String key, String value)
void	setKeyValue(String cgi)
void	setTagEntity(UCMEntity entity)
String	stringify() Returns a string representation of the entity object
String	toString()

Methods inherited from class net.praqma.clearcase.ucm.entities.UCMEntity

autoLoad, changeOwnership, changeOwnership, equals, getargComment, getargIn, getComment, getDate, getEntity, getEntity, getEntitySelector, getFqname, getFullyQualifiedName, getHyperlinks, getKind, getLabelStatus, getLabelStatusFromString, getMastership, getNamePart, getNormalizedName, getObjectId, getObjectId, getPVob, getShortname, getTag, getUser, hashCode, isLoaded, loadDate, setComment, setDate, setDate, setFqname, setKind, setLabelStatusFromString, setMastership, setUser

Methods inherited from class net.praqma.clearcase.ClearCase

createSimpleAttributeType, getAttribute, getAttributes, getAttributes, getAttributes, setAttribute, setAttribute

Methods inherited from class net.praqma.clearcase.Cool

getOS

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__TAG_NAME

public static final String __TAG_NAME

The tag name in ClearCase

See Also:

Constant Field Values

Method Detail

initialize

public void initialize()

Description copied from class: UCMEntity

initialise the UCM entity. This is a base implementation, storing the short name and PVob.

Overrides:

initialize in class UCMEntity

CGIToHash

public static Map<String,String> CGIToHash(String cgi)

queryTag

public boolean queryTag(TagQuery query)

mapToCGI

public static String mapToCGI(Map<String,String> keyval)

mapToCGI

public static String mapToCGI(Map<String,String> keyval,
                              boolean skiptaginfo)

load

public Tag load()

Is used by Stringify

Overrides:

load in class UCMEntity

Returns:

The loaded Tag

setKeyValue

public void setKeyValue(String cgi)

setEntry

public void setEntry(String key,
                     String value)

removeEntry

public boolean removeEntry(String key)

getEntry

public String getEntry(String key)

GetEntries

public Map<String,String> GetEntries()

setTagEntity

public void setTagEntity(UCMEntity entity)

getTagEntity

public UCMEntity getTagEntity()

persist

public Tag persist()
            throws TagException,
                   UnableToCreateEntityException,
                   UnableToLoadEntityException,
                   UCMEntityNotFoundException,
                   UnableToGetEntityException,
                   UnableToInitializeEntityException

Persist the Tag. Returns the new Tag from ClearCase.

Returns:

The new Tag.

Throws:

UnableToInitializeEntityException - Thrown on ClearCase error

TagException - Thrown on ClearCase error

UCMEntityNotFoundException - Thrown on ClearCase error

UnableToLoadEntityException - Thrown on ClearCase error

UnableToCreateEntityException - Thrown on ClearCase error

UnableToGetEntityException - Thrown on ClearCase error

persist

public static Tag persist(Tag tag)
                   throws TagException,
                          UnableToCreateEntityException,
                          UnableToLoadEntityException,
                          UCMEntityNotFoundException,
                          UnableToGetEntityException,
                          UnableToInitializeEntityException

Throws:

TagException

UnableToCreateEntityException

UnableToLoadEntityException

UCMEntityNotFoundException

UnableToGetEntityException

UnableToInitializeEntityException

getTags

public static List<Tag> getTags(UCMEntity entity)
                         throws TagException,
                                UnableToInitializeEntityException

Throws:

TagException

UnableToInitializeEntityException

getTag

public static Tag getTag(UCMEntity entity,
                         String tagType,
                         String tagID,
                         boolean create)
                  throws TagException,
                         UnableToInitializeEntityException,
                         UnableToCreateEntityException,
                         UCMEntityNotFoundException,
                         UnableToGetEntityException

Throws:

TagException

UnableToInitializeEntityException

UnableToCreateEntityException

UCMEntityNotFoundException

UnableToGetEntityException

setCreated

public void setCreated(boolean created)

Overrides:

setCreated in class UCMEntity

isCreated

public boolean isCreated()

Overrides:

isCreated in class UCMEntity

getTagType

public String getTagType()

getTagID

public String getTagID()

stringify

public String stringify()

Description copied from class: UCMEntity

Returns a string representation of the entity object

Overrides:

stringify in class UCMEntity

Returns:

A String

toString

public String toString()

Overrides:

toString in class UCMEntity

Returns:

A shorthand representation of the object.