com.bea.wli.config.component.impl

Class ProjectHierarchy

java.lang.Object

com.bea.wli.config.component.impl.ProjectHierarchy

public final class ProjectHierarchy
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ProjectHierarchy(boolean isTransactional, TransactionManager txmgr)
ProjectHierarchy(TransactionManager txmgr)

Method Summary

Modifier and Type	Method and Description
void	addNode(Ref ref) Adds a particular reference to the hierarchy
void	deleteNode(Ref theref) Removes a node from the hierarchy.
boolean	exists(Ref ref) Returns true if a node exists in the hierarchy
java.util.Set<Ref>	expand(java.util.Collection<Ref> initialrefs) Expands a given collection of references and returns a set of resource references.
java.util.Set<Ref>	expand(RefValueDomain valueDomain) Returns a set of references to existing resources that belong to the given value domain
java.util.Set<Ref>	getChildren(Ref root, boolean recursive) Returns children of a node.
java.util.Set<Ref>	getLocations(Ref root, boolean recursive) Returns all the projects/folders below this node.
java.util.Set<Ref>	getResources(Ref root, boolean recursive) Returns all resources below this node.
void	rename(Ref oldref, Ref newref) Renames a given reference

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectHierarchy

public ProjectHierarchy(TransactionManager txmgr)

ProjectHierarchy

public ProjectHierarchy(boolean isTransactional,
                        TransactionManager txmgr)

Method Detail

addNode

public void addNode(Ref ref)
             throws AlreadyExistsException

Adds a particular reference to the hierarchy

Throws:

AlreadyExistsException

deleteNode

public void deleteNode(Ref theref)
                throws NotFoundException

Removes a node from the hierarchy. if the node contains children they are removed as well. If the node removed is the last node of the parent, the parent is removed (recursively too). Domain nodes are never removed

Throws:

NotFoundException

exists

public boolean exists(Ref ref)

Returns true if a node exists in the hierarchy

getChildren

public java.util.Set<Ref> getChildren(Ref root,
                                      boolean recursive)
                               throws NotFoundException,
                                      java.lang.IllegalArgumentException

Returns children of a node. If recursive is true it returns all descencdants. otherwise it returns immediate children.

Parameters:

root -

recursive - if true returns all descendants. otherwise returns only immediate children

Throws:

NotFoundException - if the given root location does not exist

java.lang.IllegalArgumentException - if the root refers to a resource

getLocations

public java.util.Set<Ref> getLocations(Ref root,
                                       boolean recursive)
                                throws NotFoundException,
                                       java.lang.IllegalArgumentException

Returns all the projects/folders below this node. To obtain all projects pass Ref.DOMAIN as argument

Parameters:

root - reference to domain, project or folder.

recursive - if true, recursively gets locations from children

Throws:

NotFoundException - if the given root location does not exist

java.lang.IllegalArgumentException - if the root refers to a resource

getResources

public java.util.Set<Ref> getResources(Ref root,
                                       boolean recursive)
                                throws NotFoundException,
                                       java.lang.IllegalArgumentException

Returns all resources below this node.

Parameters:

root - reference to domain, project or folder

recursive - if true, recursively gets resources from children

Throws:

NotFoundException - if the given root location does not exist

java.lang.IllegalArgumentException - if the root refers to a resource

rename

public void rename(Ref oldref,
                   Ref newref)
            throws NotFoundException,
                   AlreadyExistsException

Renames a given reference

Throws:

NotFoundException - if oldref is not found

AlreadyExistsException - if newref already exists

expand

public java.util.Set<Ref> expand(java.util.Collection<Ref> initialrefs)
                          throws NotFoundException

Expands a given collection of references and returns a set of resource references. The input collection can contain references to resources, projects, folders or the special domain reference (Ref.DOMAIN). Project, folder, and domain references are expanded by obtaining references to all resources under these entities.

Parameters:

initialrefs - a collection of references to resources, projects, or folders. projects and folders are expanded and replaced with references to resources within those projects/folders. The collection can contain the special domain reference, Ref.DOMAIN, in which case the result contains version information about all the resources in the domain. A null value essentially behaves as if Ref.DOMAIN is passed, that is it will cause the result to contain version information for all the resources in the damain.

Returns:

a collection of resource references.

Throws:

NotFoundException

expand

public java.util.Set<Ref> expand(RefValueDomain valueDomain)

Returns a set of references to existing resources that belong to the given value domain

Returns:

a set of references