com.bea.wli.config.impl

Class ReferenceViewImpl

java.lang.Object

com.bea.wli.config.impl.ReferenceViewImpl

All Implemented Interfaces:

ReferenceView

public class ReferenceViewImpl
extends java.lang.Object
implements ReferenceView

Impl of the ReferenceView. Most methods do not need specific transaction handling as the reference maps are already transactional.

Constructor Summary

Constructors

Constructor and Description
ReferenceViewImpl(ConfigContextImpl configContext) constructor

Method Summary

Modifier and Type	Method and Description
java.util.Set<Ref>	findDependencies(Ref ref, java.util.Set<java.lang.String> typeIds, java.util.Set<java.lang.String> frontier, boolean includeMissingRefs) Returns the list of all dependencies recursively starting from the given ref.
java.util.Set<Ref>	findDependents(Ref ref, java.util.Set<java.lang.String> typeIds, java.util.Set<java.lang.String> frontier) Returns the list of all dependents recursively starting from the given ref.
java.util.Set<Ref>	getChildren(Ref ref) returns the children contained in the parent ref.
java.util.Set<Ref>	getDependencies(Ref ref) returns the dependencies (resources) for the given ref.
java.util.Set<Ref>	getDependents(Ref ref) returns the dependents (resources) for the given ref - i.e.
Ref	getParent(Ref ref) returns the parent for the given child ref.
boolean	hasCycle(Ref ref) returns whether the given ref defines a cycle.
boolean	hasCycle(Ref ref, java.util.Set<Ref> futureReferences) returns whether the given ref will define a cycle if added the given references.
boolean	hasDependencies(Ref ref) returns whether the given ref has dependencies
boolean	hasDependents(Ref ref) returns whether the given ref has dependents
boolean	isInCycle(Ref ref, java.util.Set<Ref> cycle) returns whether the given ref is 'in' a cycle.
void	sort(java.util.List<Ref> refs) sorts the given list of resources (the list must allow sorting) by deletion order - i.e.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReferenceViewImpl

public ReferenceViewImpl(ConfigContextImpl configContext)

constructor

Method Detail

hasDependencies

public boolean hasDependencies(Ref ref)
                        throws NotFoundException

Description copied from interface: ReferenceView

returns whether the given ref has dependencies

Specified by:

hasDependencies in interface ReferenceView

Throws:

NotFoundException

getDependencies

public java.util.Set<Ref> getDependencies(Ref ref)
                                   throws NotFoundException

Description copied from interface: ReferenceView

returns the dependencies (resources) for the given ref.

For a resource, this basically returns the result of calling computeExternalReferences on this resource type def. For a location, this is the set of all resources that are outside this location but referenced by at least one resource in that location.

Specified by:

getDependencies in interface ReferenceView

Throws:

NotFoundException

findDependencies

public java.util.Set<Ref> findDependencies(Ref ref,
                                           java.util.Set<java.lang.String> typeIds,
                                           java.util.Set<java.lang.String> frontier,
                                           boolean includeMissingRefs)
                                    throws NotFoundException

Description copied from interface: ReferenceView

Returns the list of all dependencies recursively starting from the given ref.

Specified by:

findDependencies in interface ReferenceView

Parameters:

ref - the ref to start from

typeIds - types of references to consider. If null, consider all types of references

frontier - indicates when to stop recursing (searching) along an edge. If non-null, and if recursing along an edge from Node A to Node B, the search stops along that edge stops after processing B. In other words there will be no recursing from Node B to its dependencies. If the value is null, the search does not stop based on the node type.

includeMissingRefs - whether to include a reference in the result set even if it does not exist.

Throws:

NotFoundException

hasDependents

public boolean hasDependents(Ref ref)

Description copied from interface: ReferenceView

returns whether the given ref has dependents

note: a resource may have dependents even it if does not exist. This can happen if A depends on B and B gets deleted.

Specified by:

hasDependents in interface ReferenceView

getDependents

public java.util.Set<Ref> getDependents(Ref ref)

Description copied from interface: ReferenceView

returns the dependents (resources) for the given ref - i.e. resources that have a reference to the given ref.

For a location, this is the set of all resources that are outside this location but that reference a resource in that location.

note: a resource may have dependents even it if does not exist. This can happen if A depends on B and B gets deleted.

Specified by:

getDependents in interface ReferenceView

findDependents

public java.util.Set<Ref> findDependents(Ref ref,
                                         java.util.Set<java.lang.String> typeIds,
                                         java.util.Set<java.lang.String> frontier)

Description copied from interface: ReferenceView

Returns the list of all dependents recursively starting from the given ref.

note: a resource may have dependents even it if does not exist. This can happen if A depends on B and B gets deleted.

Specified by:

findDependents in interface ReferenceView

Parameters:

ref - the ref to start from

typeIds - types of references to consider. If null, consider all types of references

frontier - indicates when to stop recursing (searching) along an edge. If non-null, and if recursing along an edge from Node A to Node B, the search stops along that edge stops after processing B. In other words there will be no recursing from Node B to its dependents. If the value is null, the search does not stop based on the node type.

hasCycle

public boolean hasCycle(Ref ref)
                 throws NotFoundException

Description copied from interface: ReferenceView

returns whether the given ref defines a cycle. The resource can either belong to a cycle, or have a dependency to a resource that belongs to a cycle.

Specified by:

hasCycle in interface ReferenceView

Throws:

NotFoundException

hasCycle

public boolean hasCycle(Ref ref,
                        java.util.Set<Ref> futureReferences)
                 throws NotFoundException

Description copied from interface: ReferenceView

returns whether the given ref will define a cycle if added the given references.

Specified by:

hasCycle in interface ReferenceView

Throws:

NotFoundException

isInCycle

public boolean isInCycle(Ref ref,
                         java.util.Set<Ref> cycle)
                  throws NotFoundException

Description copied from interface: ReferenceView

returns whether the given ref is 'in' a cycle. A set can be passed as argument to be populated with the refs constituting that cycle (if a cycle is found, it will contain the given ref as well).

Specified by:

isInCycle in interface ReferenceView

Throws:

NotFoundException

getParent

public Ref getParent(Ref ref)
              throws ValidationException

Description copied from interface: ReferenceView

returns the parent for the given child ref. The ref must represent a resource which type def implements ChildType.

Specified by:

getParent in interface ReferenceView

Throws:

ValidationException - thrown if the parent cannot be found or if multiple parent exists

getChildren

public java.util.Set<Ref> getChildren(Ref ref)
                               throws NotFoundException

Description copied from interface: ReferenceView

returns the children contained in the parent ref. The ref must represent a resource which type def implements ParentType.

Specified by:

getChildren in interface ReferenceView

Throws:

NotFoundException

sort

public void sort(java.util.List<Ref> refs)
          throws NotFoundException

Description copied from interface: ReferenceView

sorts the given list of resources (the list must allow sorting) by deletion order - i.e. resources will be sorted in an order that it is safe to delete them.

Specified by:

sort in interface ReferenceView

Throws:

NotFoundException