org.apache.jackrabbit.oak.plugins.nodetype

Interface EffectiveNodeTypeProvider

All Known Implementing Classes:

ReadOnlyNodeTypeManager, ReadWriteNodeTypeManager

public interface EffectiveNodeTypeProvider

EffectiveNodeTypeProvider... TODO

Method Summary

Modifier and Type	Method and Description
EffectiveNodeType	getEffectiveNodeType(Node targetNode) Calculates and returns the effective node types of the given node.
boolean	isNodeType(java.lang.String primaryTypeName, java.util.Iterator<java.lang.String> mixinTypes, java.lang.String nodeTypeName) Returns true if typeName is of the specified primary node type or mixin type, or a subtype thereof.
boolean	isNodeType(java.lang.String typeName, java.lang.String superName) Returns true if typeName is of the specified primary node type or mixin type, or a subtype thereof.
boolean	isNodeType(Tree tree, java.lang.String nodeTypeName) Returns true if this tree is of the specified primary node type or mixin type, or a subtype thereof respecting the effective node type of the tree.

Method Detail

isNodeType

boolean isNodeType(Tree tree,
                   java.lang.String nodeTypeName)
            throws NoSuchNodeTypeException,
                   RepositoryException

Returns true if this tree is of the specified primary node type or mixin type, or a subtype thereof respecting the effective node type of the tree. Returns false otherwise.

Parameters:

tree - The tree to be tested.

nodeTypeName - The internal oak name of the node type to be tested.

Returns:

true if the specified node is of the given node type.

Throws:

NoSuchNodeTypeException - If the specified node type name doesn't refer to an existing node type.

RepositoryException - If the given node type name is invalid or if some other error occurs.

isNodeType

boolean isNodeType(java.lang.String primaryTypeName,
                   java.util.Iterator<java.lang.String> mixinTypes,
                   java.lang.String nodeTypeName)
            throws NoSuchNodeTypeException,
                   RepositoryException

Returns true if typeName is of the specified primary node type or mixin type, or a subtype thereof. Returns false otherwise.

Parameters:

primaryTypeName - the internal oak name of the node to test

mixinTypes - the internal oak names of the node to test.

nodeTypeName - The internal oak name of the node type to be tested.

Returns:

true if the specified node type is of the given node type.

Throws:

NoSuchNodeTypeException - If the specified node type name doesn't refer to an existing node type.

RepositoryException - If the given node type name is invalid or if some other error occurs.

isNodeType

boolean isNodeType(java.lang.String typeName,
                   java.lang.String superName)

Returns true if typeName is of the specified primary node type or mixin type, or a subtype thereof. Returns false otherwise.

Parameters:

typeName - the internal oak name of the node type to test

superName - The internal oak name of the super type to be tested for.

Returns:

true if the specified node type is of the given node type.

getEffectiveNodeType

EffectiveNodeType getEffectiveNodeType(Node targetNode)
                                throws RepositoryException

Calculates and returns the effective node types of the given node. Also see JCR 2.0 Specification, Section 3.7.6.5 for the definition of the effective node type.

Parameters:

targetNode - the node for which the types should be calculated.

Returns:

all types of the given node

Throws:

RepositoryException - if the type information can not be accessed

See Also:

JCR 2.0 Specification, Section 3.7.6.5