net.praqma.clearcase.ucm.entities

Class Baseline

java.lang.Object

net.praqma.clearcase.Cool

net.praqma.clearcase.ClearCase

net.praqma.clearcase.ucm.entities.UCMEntity

net.praqma.clearcase.ucm.entities.Baseline

All Implemented Interfaces:

Serializable, Diffable

public class Baseline
extends UCMEntity
implements Diffable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Baseline.LabelBehaviour

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

UCMEntity.Kind, UCMEntity.LabelStatus

Field Summary

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 Baseline	create(Stream stream, Component component, String basename, File view, Baseline.LabelBehaviour labelBehaviour, boolean identical)
static Baseline	create(String basename, Component component, File view, Baseline.LabelBehaviour labelBehaviour, boolean identical)
static Baseline	create(String basename, Component component, File view, Baseline.LabelBehaviour labelBehaviour, boolean identical, List<Activity> activities, List<Component> depends) Given a baseline basename, a component and a view, the baseline is created.
static Baseline	get(String name)
static Baseline	get(String name, PVob pvob)
Component	getComponent()
List<Baseline>	getCompositeDependantBaselines() Get all the composite Baselines that are dependant on this Baseline.
List<Baseline>	getCompositeDependantBaselines(Component component) Get all the composite Baselines that are dependant on this Baseline given a specific Component.
List<Baseline>	getCompositeMemberBaselines() Get all the composite Baselines that are members of this Baseline.
List<Baseline>	getCompositeMemberBaselines(Component component) Get all the composite Baselines that are members of this Baseline given a specific Component.
List<Baseline>	getDependent() Get the List of Baseline's, that depends on this Baseline.
List<Baseline>	getPostedBaselinesFor(Component component)
Project.PromotionLevel	getPromotionLevel()
Baseline	getRootedBaseline() Get the rooted version of this Baseline.
Stream	getStream()
boolean	isCompositeBaseline()
Baseline	load() Load the Baseline into memory from ClearCase. This function is automatically called when needed by other functions.
Baseline	load(boolean force)
Project.PromotionLevel	promote() Promote the Baseline.
Project.PromotionLevel	reject() REJECTED the Baseline.
void	resetMastership()
void	setLocalPromotionLevel(Project.PromotionLevel plevel) Set the Project.PromotionLevel of this Baseline, without persisting it in ClearCase.
void	setPromotionLevel(Project.PromotionLevel plevel) Set the Project.PromotionLevel
boolean	shouldResetMastership()
String	stringify() Returns a string representation of the entity object

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, initialize, isCreated, isLoaded, loadDate, setComment, setCreated, setDate, setDate, setFqname, setKind, setLabelStatusFromString, setMastership, setUser, 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

Methods inherited from interface net.praqma.clearcase.interfaces.Diffable

getFullyQualifiedName

Method Detail

load

public Baseline load(boolean force)
              throws UnableToLoadEntityException,
                     UnableToInitializeEntityException

Throws:

UnableToLoadEntityException

UnableToInitializeEntityException

load

public Baseline load()
              throws UnableToLoadEntityException,
                     UnableToInitializeEntityException

Load the Baseline into memory from ClearCase.
This function is automatically called when needed by other functions.

Overrides:

load in class UCMEntity

Returns:

The baseline in question, with stream and component data

Throws:

UnableToLoadEntityException - Thrown when ClearCase reports errors

UnableToInitializeEntityException - Thrown when ClearCase reports errors

create

public static Baseline create(String basename,
                              Component component,
                              File view,
                              Baseline.LabelBehaviour labelBehaviour,
                              boolean identical)
                       throws UnableToInitializeEntityException,
                              UnableToCreateEntityException,
                              NothingNewException

Throws:

UnableToInitializeEntityException

UnableToCreateEntityException

NothingNewException

create

public static Baseline create(Stream stream,
                              Component component,
                              String basename,
                              File view,
                              Baseline.LabelBehaviour labelBehaviour,
                              boolean identical)
                       throws UnableToInitializeEntityException,
                              UnableToCreateEntityException,
                              NothingNewException

Throws:

UnableToInitializeEntityException

UnableToCreateEntityException

NothingNewException

create

public static Baseline create(String basename,
                              Component component,
                              File view,
                              Baseline.LabelBehaviour labelBehaviour,
                              boolean identical,
                              List<Activity> activities,
                              List<Component> depends)
                       throws UnableToInitializeEntityException,
                              UnableToCreateEntityException,
                              NothingNewException

Given a baseline basename, a component and a view, the baseline is created.

Parameters:

basename - The base name for the new Baseline

component - The Component in which the baseline should be created

view - Current SnapshotView view root.

labelBehaviour - The Baseline.LabelBehaviour to use.

identical - Should we allow identical baselines to be created?

activities - Activities

depends - Add Component dependencies

Returns:

Created baselines with the given arguments

Throws:

UnableToInitializeEntityException - Thrown when ClearCase reports errors

UnableToCreateEntityException - Thrown when ClearCase reports errors

NothingNewException - Thrown when ClearCase reports errors

getPromotionLevel

public Project.PromotionLevel getPromotionLevel()

promote

public Project.PromotionLevel promote()
                               throws UnableToPromoteBaselineException

Promote the Baseline.

• INITIAL to BUILT
• BUILD to TESTED
• TESTED to RELEASED

If the promotion level is not set, it is set to INITAL.

Returns:

The new promotion level.

Throws:

UnableToPromoteBaselineException - Thrown when ClearCase reports errors

reject

public Project.PromotionLevel reject()
                              throws UnableToPromoteBaselineException

REJECTED the Baseline.

Returns:

The rejected Project.PromotionLevel

Throws:

UnableToPromoteBaselineException - Thrown when ClearCase reports errors

setPromotionLevel

public void setPromotionLevel(Project.PromotionLevel plevel)
                       throws UnableToPromoteBaselineException

Set the Project.PromotionLevel

Parameters:

plevel - The new Project.PromotionLevel

Throws:

UnableToPromoteBaselineException - Thrown when ClearCase reports errors

setLocalPromotionLevel

public void setLocalPromotionLevel(Project.PromotionLevel plevel)

Set the Project.PromotionLevel of this Baseline, without persisting it in ClearCase.

Parameters:

plevel - Set the new promotion level

getComponent

public Component getComponent()

getDependent

public List<Baseline> getDependent()
                            throws CleartoolException,
                                   UnableToInitializeEntityException

Get the List of Baseline's, that depends on this Baseline.

Returns:

A list of dependant baselines

Throws:

CleartoolException - Thrown when ClearCase reports errors

UnableToInitializeEntityException - Thrown when ClearCase reports errors

getStream

public Stream getStream()

shouldResetMastership

public boolean shouldResetMastership()
                              throws ClearCaseException

Throws:

ClearCaseException

resetMastership

public void resetMastership()
                     throws ClearCaseException

Throws:

ClearCaseException

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

get

public static Baseline get(String name)
                    throws UnableToInitializeEntityException

Throws:

UnableToInitializeEntityException

get

public static Baseline get(String name,
                           PVob pvob)
                    throws UnableToInitializeEntityException

Throws:

UnableToInitializeEntityException

getPostedBaselinesFor

public List<Baseline> getPostedBaselinesFor(Component component)
                                     throws UnableToInitializeEntityException,
                                            CleartoolException

Throws:

UnableToInitializeEntityException

CleartoolException

getCompositeMemberBaselines

public List<Baseline> getCompositeMemberBaselines()
                                           throws UnableToInitializeEntityException,
                                                  CleartoolException

Get all the composite Baselines that are members of this Baseline. That is, Baselines that are descendants of this.

Returns:

A list of composite member Baselines

Throws:

UnableToInitializeEntityException - Thrown when ClearCase reports errors

CleartoolException - Thrown when ClearCase reports errors

getCompositeMemberBaselines

public List<Baseline> getCompositeMemberBaselines(Component component)
                                           throws UnableToInitializeEntityException,
                                                  CleartoolException

Get all the composite Baselines that are members of this Baseline given a specific Component.

That is, Baselines that are descendants of this.

Parameters:

component - A list of components to consider

Returns:

A list of composite member Baselines

Throws:

UnableToInitializeEntityException - Thrown when ClearCase reports errors

CleartoolException - Thrown when ClearCase reports errors

getCompositeDependantBaselines

public List<Baseline> getCompositeDependantBaselines()
                                              throws UnableToInitializeEntityException,
                                                     CleartoolException

Get all the composite Baselines that are dependant on this Baseline. That is, Baselines that are ancestors of this.

Returns:

A list of composite baselines that depend on this Baseline

Throws:

UnableToInitializeEntityException - Thrown when a ClearTool error occurs

CleartoolException - Thrown when a ClearTool error occurs

getCompositeDependantBaselines

public List<Baseline> getCompositeDependantBaselines(Component component)
                                              throws UnableToInitializeEntityException,
                                                     CleartoolException

Get all the composite Baselines that are dependant on this Baseline given a specific Component. That is, Baselines that are ancestors of this.

Parameters:

component - The Component to look under

Returns:

A list of Baselines

Throws:

UnableToInitializeEntityException - Thrown when ClearCase reports errors

CleartoolException - Thrown when ClearCase reports errors

getRootedBaseline

public Baseline getRootedBaseline()
                           throws UnableToInitializeEntityException,
                                  CleartoolException

Get the rooted version of this Baseline. Returns null if none found.

Returns:

The first rooted baseline

Throws:

UnableToInitializeEntityException - Thrown when ClearCase reports errors

CleartoolException - Thrown when ClearCase reports errors

isCompositeBaseline

public boolean isCompositeBaseline()
                            throws UnableToInitializeEntityException,
                                   CleartoolException

Throws:

UnableToInitializeEntityException

CleartoolException