net.sourceforge.cruisecontrol.sourcecontrols
Class UCM

java.lang.Object
  extended bynet.sourceforge.cruisecontrol.sourcecontrols.UCM
All Implemented Interfaces:
java.io.Serializable, SourceControl

public class UCM
extends java.lang.Object
implements SourceControl

This class implements the SourceControlElement methods for ClearCase UCM.

Author:
Kevin Lee, Alex Batlin
See Also:
Serialized Form

Constructor Summary
UCM()
           
 
Method Summary
 Commandline buildDescribeActivityCommand(java.lang.String activityID)
          construct a command to get all the activities on the specified stream
protected  Commandline buildDetectRebasesCommand(java.lang.String lastBuildDate)
           
protected  Commandline buildGetHyperlinkCommandline(java.lang.String linkName)
           
 Commandline buildListContributorsCommand(java.lang.String activityID)
          construct a command to get all the activities on the specified stream
 Commandline buildListStreamCommand(java.lang.String lastBuildDate)
          construct a command to get all the activities on the specified stream
 java.util.List getModifications(java.util.Date lastBuild, java.util.Date now)
          Get a List of modifications detailing all the changes between now and the last build.
 java.util.Map getProperties()
          Any properties that have been set in this sourcecontrol.
 java.lang.String getPvob()
          Get the name of the pvob to use for queries.
 java.lang.String getStream()
          get which stream is being checked
 java.lang.String getViewPath()
          get the starting point path in a view to check for changes
 boolean isContributors()
          get whether contributors are to be found
 boolean isMultiVob()
          get whether the view contains multiple vobs
 boolean isRebases()
          Gets whether rebases are to be reported as changes.
 void setContributors(boolean contributors)
          set whether contributors are to be found
 void setMultiVob(boolean multiVob)
          set whether the view contains multiple vobs
 void setProperty(java.lang.String property)
          set the name of the property that will be set if modifications are found
 void setPvob(java.lang.String pvob)
          Set the name of the pvob to use for queries.
 void setRebases(boolean rebases)
          Sets whether rebases of the integration stream are reported as changes.
 void setStream(java.lang.String stream)
          set the stream to check for changes
 void setViewPath(java.lang.String viewPath)
          set the starting point path in a view to check for changes
 void validate()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UCM

public UCM()
Method Detail

getProperties

public java.util.Map getProperties()
Description copied from interface: SourceControl
Any properties that have been set in this sourcecontrol. Will be passed onto the Builder, which may then pass the properties to the underlying build implementation. For example, the Ant builder will define these properties so that the underlying Ant script can use them.

Specified by:
getProperties in interface SourceControl

validate

public void validate()
              throws CruiseControlException
Specified by:
validate in interface SourceControl
Throws:
CruiseControlException

getStream

public java.lang.String getStream()
get which stream is being checked

Returns:
the name of the stream being checked

setStream

public void setStream(java.lang.String stream)
set the stream to check for changes

Parameters:
stream - the stream to be checked (via its underlying branch)

getViewPath

public java.lang.String getViewPath()
get the starting point path in a view to check for changes

Returns:
path inside a view

setViewPath

public void setViewPath(java.lang.String viewPath)
set the starting point path in a view to check for changes

Parameters:
viewPath - path inside a view

isMultiVob

public boolean isMultiVob()
get whether the view contains multiple vobs

Returns:
true, if the view contains multiple vobs, else false

setMultiVob

public void setMultiVob(boolean multiVob)
set whether the view contains multiple vobs


setPvob

public void setPvob(java.lang.String pvob)
Set the name of the pvob to use for queries.

Parameters:
pvob - the pvob

getPvob

public java.lang.String getPvob()
Get the name of the pvob to use for queries.

Returns:
The name of the pvob

isRebases

public boolean isRebases()
Gets whether rebases are to be reported as changes.

Returns:
true, if rebases are to be reported, else false

setRebases

public void setRebases(boolean rebases)
Sets whether rebases of the integration stream are reported as changes.

Parameters:
rebases - boolean indicating whether rebases are to be reported as changes

isContributors

public boolean isContributors()
get whether contributors are to be found

Returns:
true, if contributors are to be found, else false

setContributors

public void setContributors(boolean contributors)
set whether contributors are to be found

Parameters:
contributors - boolean indicating whether contributors are to be found

setProperty

public void setProperty(java.lang.String property)
set the name of the property that will be set if modifications are found

Parameters:
property - The name of the property to set

getModifications

public java.util.List getModifications(java.util.Date lastBuild,
                                       java.util.Date now)
Get a List of modifications detailing all the changes between now and the last build. Return this as an element. It is not necessary for sourcecontrols to actually do anything other than returning a chunk of XML data back.

Specified by:
getModifications in interface SourceControl
Parameters:
lastBuild - time of last build
now - time this build started
Returns:
a list of XML elements that contains data about the modifications that took place. If no changes, this method returns an empty list.

buildListStreamCommand

public Commandline buildListStreamCommand(java.lang.String lastBuildDate)
construct a command to get all the activities on the specified stream


buildDescribeActivityCommand

public Commandline buildDescribeActivityCommand(java.lang.String activityID)
construct a command to get all the activities on the specified stream


buildListContributorsCommand

public Commandline buildListContributorsCommand(java.lang.String activityID)
construct a command to get all the activities on the specified stream


buildDetectRebasesCommand

protected Commandline buildDetectRebasesCommand(java.lang.String lastBuildDate)

buildGetHyperlinkCommandline

protected Commandline buildGetHyperlinkCommandline(java.lang.String linkName)