UCMEntity (ClearCase UCM library Plugin 1.0.0 API)

java.lang.Object
- net.praqma.clearcase.Cool
- - net.praqma.clearcase.ClearCase
  - - net.praqma.clearcase.ucm.entities.UCMEntity

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Activity, Baseline, Component, Folder, HyperLink, Project, Stream, Tag, Version
```
public abstract class UCMEntity
extends ClearCase
implements Serializable
```
Author:

wolfgang

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UCMEntity.Kind

static class UCMEntity.LabelStatus

Nested Classes
Modifier and Type	Class and Description
`static class`	`UCMEntity.Kind`
`static class`	`UCMEntity.LabelStatus`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Date`	`date`
`static DateFormat`	`dateFormatter`
`protected String`	`fqname`
`protected UCMEntity.Kind`	`kind`
`protected UCMEntity.LabelStatus`	`labelStatus`
`protected boolean`	`loaded`
`protected String`	`mastership`
`protected static Pattern`	`pattern_std_fqname`
`protected static Pattern`	`pattern_tag_fqname`
`protected static Pattern`	`pattern_version_fqname`
`protected PVob`	`pvob`
`protected static String`	`rx_ccdef_allowed`
`protected static String`	`rx_ccdef_cc_name`
`protected static String`	`rx_ccdef_filename`
`protected static String`	`rx_ccdef_vob`
`protected String`	`shortname`
`protected String`	`user`
`protected Vob`	`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

Constructor Summary

Constructors
Modifier Constructor and Description

protected UCMEntity(String entitySelector)

Constructors
Modifier	Constructor and Description
`protected`	`UCMEntity(String entitySelector)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`autoLoad()`
`void`	`changeOwnership(String username, File viewContext)`
`static void`	`changeOwnership(UCMEntity entity, String username, File viewContext)`
`boolean`	`equals(Object other)`
`static String`	`getargComment(String comment)`
`static String`	`getargIn(String in)`
`String`	`getComment()`
`Date`	`getDate()`
`protected static UCMEntity`	`getEntity(Class<? extends UCMEntity> clazz, String fqname)` Generates a UCM entity given its fully qualified name.
`static UCMEntity`	`getEntity(String fqname)`
`String`	`getEntitySelector()`
`String`	`getFqname()`
`String`	`getFullyQualifiedName()`
`List<HyperLink>`	`getHyperlinks(String hyperlinkType, File context)`
`UCMEntity.Kind`	`getKind()`
`UCMEntity.LabelStatus`	`getLabelStatus()`
`UCMEntity.LabelStatus`	`getLabelStatusFromString(String ls)`
`String`	`getMastership()`
`static String`	`getNamePart(String fqname)`
`String`	`getNormalizedName()`
`String`	`getObjectId()`
`static String`	`getObjectId(String name)`
`PVob`	`getPVob()`
`String`	`getShortname()`
`Tag`	`getTag(String tagType, String tagID)`
`String`	`getUser()`
`int`	`hashCode()`
`protected void`	`initialize()` initialise the UCM entity.
`boolean`	`isCreated()`
`boolean`	`isLoaded()`
`UCMEntity`	`load()` Default load functionality for the entity.
`void`	`loadDate()`
`void`	`setComment(String comment)`
`void`	`setCreated(boolean created)`
`void`	`setDate(Date date)`
`void`	`setDate(String date)`
`void`	`setFqname(String fqname)`
`void`	`setKind(UCMEntity.Kind kind)`
`void`	`setLabelStatusFromString(String labelStatus)`
`void`	`setMastership(String mastership)`
`void`	`setUser(String user)` Set the user responsible for this entity
`String`	`stringify()` Returns a string representation of the entity object
`String`	`toString()`

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

rx_ccdef_allowed

protected static final String rx_ccdef_allowed

See Also:: Constant Field Values

rx_ccdef_vob

protected static final String rx_ccdef_vob

See Also:: Constant Field Values

pattern_std_fqname

protected static final Pattern pattern_std_fqname

pattern_version_fqname

protected static final Pattern pattern_version_fqname

rx_ccdef_filename

protected static final String rx_ccdef_filename

See Also:: Constant Field Values

pattern_tag_fqname

protected static final Pattern pattern_tag_fqname

rx_ccdef_cc_name

protected static final String rx_ccdef_cc_name

See Also:: Constant Field Values

kind
```
protected UCMEntity.Kind kind
```

labelStatus

protected UCMEntity.LabelStatus labelStatus

date
```
protected Date date
```

dateFormatter

public static final transient DateFormat dateFormatter

fqname
```
protected String fqname
```

shortname
```
protected String shortname
```

pvob
```
protected PVob pvob
```

vob
```
protected Vob vob
```

mastership
```
protected String mastership
```

user
```
protected String user
```

loaded
```
protected boolean loaded
```

Constructor Detail

UCMEntity

protected UCMEntity(String entitySelector)

Method Detail

getEntity
```
protected static UCMEntity getEntity(Class<? extends UCMEntity> clazz,
                                     String fqname)
                              throws UnableToInitializeEntityException
```
Generates a UCM entity given its fully qualified name.

Parameters:

clazz - The class of ClearCase object you want to git

fqname - The fully qualified ClearCase object name

Returns:

A new entity of the type given by the fully qualified name.

Throws:

UnableToInitializeEntityException - Thrown when ClearCase reports errors

initialize
```
protected void initialize()
                   throws UCMEntityNotInitializedException
```
initialise the UCM entity. This is a base implementation, storing the short name and PVob.

Throws:

UCMEntityNotInitializedException - Thrown when ClearCase reports errors

load
```
public UCMEntity load()
               throws UnableToLoadEntityException,
                      UCMEntityNotFoundException,
                      UnableToInitializeEntityException
```
Default load functionality for the entity. Every UCM entity should implement this method itself.

Returns:

The current UCMEntity

Throws:

UnableToLoadEntityException - Thrown when ClearCase reports errors

UCMEntityNotFoundException - Thrown when ClearCase reports errors

UnableToInitializeEntityException - Thrown when ClearCase reports errors

setLabelStatusFromString

public void setLabelStatusFromString(String labelStatus)

getLabelStatusFromString

public UCMEntity.LabelStatus getLabelStatusFromString(String ls)

getLabelStatus

public UCMEntity.LabelStatus getLabelStatus()

getEntity

public static UCMEntity getEntity(String fqname)
                           throws UnableToInitializeEntityException,
                                  UnknownEntityException

Throws:: UnableToInitializeEntityException; UnknownEntityException

getTag

public Tag getTag(String tagType,
                  String tagID)
           throws TagException,
                  UnableToInitializeEntityException,
                  UnableToCreateEntityException,
                  UCMEntityNotFoundException,
                  UnableToGetEntityException

Throws:: TagException; UnableToInitializeEntityException; UnableToCreateEntityException; UCMEntityNotFoundException; UnableToGetEntityException

getHyperlinks

public List<HyperLink> getHyperlinks(String hyperlinkType,
                                     File context)
                              throws HyperlinkException,
                                     UnableToInitializeEntityException

Throws:: HyperlinkException; UnableToInitializeEntityException

getUser
```
public String getUser()
```

setUser
```
public void setUser(String user)
```
Set the user responsible for this entity

Parameters:

user -

getFullyQualifiedName
```
public String getFullyQualifiedName()
```
Specified by:

getFullyQualifiedName in class ClearCase

getFqname
```
public String getFqname()
```

setFqname
```
public void setFqname(String fqname)
```

getShortname
```
public String getShortname()
```

getPVob
```
public PVob getPVob()
```

setMastership

public void setMastership(String mastership)
                   throws CleartoolException

Throws:: CleartoolException

getMastership
```
public String getMastership()
```

stringify
```
public String stringify()
```
Returns a string representation of the entity object

Returns:

A String

getNamePart

public static String getNamePart(String fqname)
                          throws CleartoolException

Throws:: CleartoolException

toString
```
public String toString()
```
Overrides:

toString in class Object

Returns:

A shorthand representation of the object.

getDate
```
public Date getDate()
```

loadDate

public void loadDate()
              throws CleartoolException

Throws:: CleartoolException

setDate
```
public void setDate(Date date)
```

setDate

public void setDate(String date)
             throws ParseException

Throws:: ParseException

setComment

public void setComment(String comment)

getComment
```
public String getComment()
```

getKind
```
public UCMEntity.Kind getKind()
```

setKind

public void setKind(UCMEntity.Kind kind)

equals
```
public boolean equals(Object other)
```
Overrides:

equals in class Object

getEntitySelector
```
public String getEntitySelector()
```

changeOwnership

public void changeOwnership(String username,
                            File viewContext)
                     throws UnknownVobException,
                            UnknownUserException,
                            UCMEntityNotFoundException,
                            CleartoolException

Throws:: UnknownVobException; UnknownUserException; UCMEntityNotFoundException; CleartoolException

changeOwnership

public static void changeOwnership(UCMEntity entity,
                                   String username,
                                   File viewContext)
                            throws UnknownVobException,
                                   UnknownUserException,
                                   UCMEntityNotFoundException,
                                   CleartoolException

Throws:: UnknownVobException; UnknownUserException; UCMEntityNotFoundException; CleartoolException

isLoaded
```
public boolean isLoaded()
```

autoLoad

protected void autoLoad()
                 throws EntityNotLoadedException

Throws:: EntityNotLoadedException

isCreated
```
public boolean isCreated()
```

setCreated

public void setCreated(boolean created)

getNormalizedName
```
public String getNormalizedName()
```

getargComment

public static String getargComment(String comment)

getargIn

public static String getargIn(String in)

getObjectId

public String getObjectId()
                   throws CleartoolException

Throws:: CleartoolException

getObjectId

public static String getObjectId(String name)
                          throws CleartoolException

Throws:: CleartoolException

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

Class UCMEntity

Nested Class Summary

Field Summary

Fields inherited from class net.praqma.clearcase.ClearCase

Fields inherited from class net.praqma.clearcase.Cool

Constructor Summary

Method Summary

Methods inherited from class net.praqma.clearcase.ClearCase

Methods inherited from class net.praqma.clearcase.Cool

Methods inherited from class java.lang.Object

Field Detail

rx_ccdef_allowed

rx_ccdef_vob

pattern_std_fqname

pattern_version_fqname

rx_ccdef_filename

pattern_tag_fqname

rx_ccdef_cc_name

kind

labelStatus

date

dateFormatter

fqname

shortname

pvob

vob

mastership

user

loaded

Constructor Detail

UCMEntity

Method Detail

getEntity

initialize

load

setLabelStatusFromString

getLabelStatusFromString

getLabelStatus

getEntity

getTag

getHyperlinks

getUser

setUser

getFullyQualifiedName

getFqname

setFqname

getShortname

getPVob

setMastership

getMastership

stringify

getNamePart

toString

getDate

loadDate

setDate

setDate

setComment

getComment

getKind

setKind

equals

getEntitySelector

changeOwnership

changeOwnership

isLoaded

autoLoad

isCreated

setCreated

getNormalizedName

getargComment

getargIn

getObjectId

getObjectId

hashCode