org.azyva.dragom.job

Class RootManager

java.lang.Object

org.azyva.dragom.job.RootManager

public class RootManager
extends Object

Class for managing root ModuleVersion's and the global ReferencePathMatcherOr within the ExecContext. The root ModuleVersion's are used by many tools to establish the ModuleVersion's on which the tool will operate. These root ModuleVersion's are generally used by tools when the user does not specify a specific root when invoking the tool. The global ReferencePathMatcherOr is also used by many tools to restrict the ReferencePath's visited while traversing the reference graphs rooted at the root ModuleVersion's. This ReferencePathMatcherOr is generally used within a ReferencePathMatcherAnd so that a ReferencePath is visited if it is matched both by this global ReferencePathMatcherOr and another ReferencePathMatcherOr provided when invoking a tool. This class is not really a job but is a helper class to help manage roots for tasks and the RootManagerTool. All methods are static since roots are defined globally within an ExecContext.

Author:

David Raymond

Constructor Summary

Constructors

Constructor and Description
RootManager()

Method Summary

Modifier and Type	Method and Description
static boolean	addModuleVersion(org.azyva.dragom.model.ModuleVersion moduleVersion, boolean indAllowDuplicateModule) Adds a ModuleVersion to the list of root ModuleVersion.
static boolean	containsModuleVersion(org.azyva.dragom.model.ModuleVersion moduleVersion) Verifies if a ModuleVersion is contained in the list of ModuleVersion.
static List<org.azyva.dragom.model.ModuleVersion>	getListModuleVersion()
static org.azyva.dragom.model.ModuleVersion	getModuleVersion(org.azyva.dragom.model.NodePath nodePathModule) Returns the ModuleVersion corresponding to a NodePath or null if none.
static org.azyva.dragom.reference.ReferencePathMatcherOr	getReferencePathMatcherOr() Returns the global ReferencePathMatcherOr.
static boolean	moveFirst(org.azyva.dragom.model.ModuleVersion moduleVersion) Moves a ModuleVersion first in the list of root ModuleVersion.
static boolean	moveLast(org.azyva.dragom.model.ModuleVersion moduleVersion) Moves a ModuleVersion last in the list of root ModuleVersion.
static void	removeAllModuleVersion() Remove all ModuleVersion's from the list of root ModuleVersion.
static boolean	removeModuleVersion(org.azyva.dragom.model.ModuleVersion moduleVersion) Remove a ModuleVersion from the list of root ModuleVersion.
static boolean	replaceModuleVersion(org.azyva.dragom.model.ModuleVersion moduleVersionOrg, org.azyva.dragom.model.ModuleVersion moduleVersionNew) Replaces a ModuleVersion with a new one (presumably having the same Module but a different Version) in the list of root ModuleVersion.
static void	saveListModuleVersion() Persists the list of root ModuleVersion's in the ExecContext.
static void	saveReferencePathMatcherOr() Persists the ReferencePathMatcherOr within the ExecContext.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RootManager

public RootManager()

Method Detail

getListModuleVersion

public static List<org.azyva.dragom.model.ModuleVersion> getListModuleVersion()

Returns:

List of root ModuleVersion's.

containsModuleVersion

public static boolean containsModuleVersion(org.azyva.dragom.model.ModuleVersion moduleVersion)

Verifies if a ModuleVersion is contained in the list of ModuleVersion.

Parameters:

moduleVersion - ModuleVersion.

Returns:

See description.

getModuleVersion

public static org.azyva.dragom.model.ModuleVersion getModuleVersion(org.azyva.dragom.model.NodePath nodePathModule)

Returns the ModuleVersion corresponding to a NodePath or null if none. Useful for managing the list when duplicate modules are not allowed.

Parameters:

nodePathModule - NodePath of the ModuleVersion.

Returns:

See description.

addModuleVersion

public static boolean addModuleVersion(org.azyva.dragom.model.ModuleVersion moduleVersion,
                                       boolean indAllowDuplicateModule)

Adds a ModuleVersion to the list of root ModuleVersion. If a ModuleVersion for the same Module is already a root and indAllowDuplicate is false, the ModuleVersion is not added. replaceModuleVersion must be called in that case.

Parameters:

moduleVersion - New root ModuleVersion.

indAllowDuplicateModule - Indicates if duplicate Module are allowed.

Returns:

Indicates if the ModuleVersion was actually added (it maybe a duplicate).

removeModuleVersion

public static boolean removeModuleVersion(org.azyva.dragom.model.ModuleVersion moduleVersion)

Remove a ModuleVersion from the list of root ModuleVersion.

Parameters:

moduleVersion - ModuleVersion to remove.

Returns:

Indicates if the ModuleVersion was actually removed (it may not be present in the list).

removeAllModuleVersion

public static void removeAllModuleVersion()

Remove all ModuleVersion's from the list of root ModuleVersion.

replaceModuleVersion

public static boolean replaceModuleVersion(org.azyva.dragom.model.ModuleVersion moduleVersionOrg,
                                           org.azyva.dragom.model.ModuleVersion moduleVersionNew)

Replaces a ModuleVersion with a new one (presumably having the same Module but a different Version) in the list of root ModuleVersion.

Parameters:

moduleVersionOrg - Original ModuleVersion.

moduleVersionNew - New ModuleVersion.

Returns:

Indicates if the ModuleVersion was actually replaced (it may not be present in the list).

moveFirst

public static boolean moveFirst(org.azyva.dragom.model.ModuleVersion moduleVersion)

Moves a ModuleVersion first in the list of root ModuleVersion.

Parameters:

moduleVersion - ModuleVersion to move first.

Returns:

Indicates if the ModuleVersion was actually moved (it may not be present in the list).

moveLast

public static boolean moveLast(org.azyva.dragom.model.ModuleVersion moduleVersion)

Moves a ModuleVersion last in the list of root ModuleVersion.

Parameters:

moduleVersion - ModuleVersion to move last.

Returns:

Indicates if the ModuleVersion was actually moved (it may not be present in the list).

saveListModuleVersion

public static void saveListModuleVersion()

Persists the list of root ModuleVersion's in the ExecContext. This class does not provide a safe encapsulation of the List of root ModuleVersion's. If the caller wants to modify the List other than with the methods provided by this class, it is expected to obtain it with the getListModuleVersion method and then call this method after having modified it. Is it not possible for the caller to create a new List and set it as the List of root ModuleVesion's within the class.

getReferencePathMatcherOr

public static org.azyva.dragom.reference.ReferencePathMatcherOr getReferencePathMatcherOr()

Returns the global ReferencePathMatcherOr. If the caller modifies the ReferencePathMatcherOr returned it should call the setReferencePathMatcherOr to ensure that it is persisted within the ExecContext.

Returns:

See description.

saveReferencePathMatcherOr

public static void saveReferencePathMatcherOr()

Persists the ReferencePathMatcherOr within the ExecContext. This class does not provide a safe encapsulation of the ReferencePathMatcherOr. If the caller wants to modify the ReferencePathMatcherOr other than with the methods provided by this class, it is expected to obtain it with the getReferencePathMatcherOr method and then call this method after having modified it. Is it not possible for the caller to create a new ReferencePathMatcherOr and set it as the global ReferencePathMatcherOr within the class. Also, only ReferencePathMatcherByElement are supported in this List.