org.apache.jackrabbit.oak.plugins.nodetype

Class EffectiveNodeType

java.lang.Object

org.apache.jackrabbit.oak.plugins.nodetype.EffectiveNodeType

public class EffectiveNodeType
extends java.lang.Object

EffectiveNodeType... TODO

Method Summary

Modifier and Type	Method and Description
void	checkMandatoryItems(Tree tree)
void	checkOrderableChildNodes()
void	checkRemoveProperty(PropertyState property)
void	checkSetProperty(PropertyState property)
java.lang.Iterable<NodeDefinition>	getAutoCreateNodeDefinitions()
java.lang.Iterable<PropertyDefinition>	getAutoCreatePropertyDefinitions()
java.lang.Iterable<NodeDefinition>	getMandatoryNodeDefinitions()
java.lang.Iterable<PropertyDefinition>	getMandatoryPropertyDefinitions()
java.lang.Iterable<NodeDefinition>	getNamedNodeDefinitions(java.lang.String oakName) Return all node definitions that match the specified oak name.
java.lang.Iterable<PropertyDefinition>	getNamedPropertyDefinitions(java.lang.String oakName) Return all property definitions that match the specified oak name.
NodeDefinition	getNodeDefinition(java.lang.String childName, EffectiveNodeType childEffective)
java.lang.Iterable<NodeDefinition>	getNodeDefinitions()
PropertyDefinition	getPropertyDefinition(java.lang.String propertyName, boolean isMultiple, int type, boolean exactTypeMatch) Calculates the applicable definition for the property with the specified characteristics under a parent with this effective type.
java.lang.Iterable<PropertyDefinition>	getPropertyDefinitions()
java.lang.Iterable<NodeDefinition>	getResidualNodeDefinitions() Return all residual node definitions.
java.lang.Iterable<PropertyDefinition>	getResidualPropertyDefinitions() Return all residual property definitions.
boolean	includesNodeType(java.lang.String nodeTypeName) Determines whether this effective node type representation includes (either through inheritance or aggregation) the given node type.
boolean	includesNodeTypes(java.lang.String[] nodeTypeNames) Determines whether this effective node type representation includes (either through inheritance or aggregation) all of the given node types.
boolean	supportsMixin(java.lang.String mixin) Determines whether this effective node type supports adding the specified mixin.

Methods inherited from class java.lang.Object

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

Method Detail

includesNodeType

public boolean includesNodeType(java.lang.String nodeTypeName)

Determines whether this effective node type representation includes (either through inheritance or aggregation) the given node type.

Parameters:

nodeTypeName - name of node type

Returns:

true if the given node type is included, otherwise false.

includesNodeTypes

public boolean includesNodeTypes(java.lang.String[] nodeTypeNames)

Determines whether this effective node type representation includes (either through inheritance or aggregation) all of the given node types.

Parameters:

nodeTypeNames - array of node type names

Returns:

true if all of the given node types are included, otherwise false

supportsMixin

public boolean supportsMixin(java.lang.String mixin)

Determines whether this effective node type supports adding the specified mixin.

Parameters:

mixin - name of mixin type

Returns:

true if the mixin type is supported, otherwise false

getNodeDefinitions

public java.lang.Iterable<NodeDefinition> getNodeDefinitions()

getPropertyDefinitions

public java.lang.Iterable<PropertyDefinition> getPropertyDefinitions()

getAutoCreateNodeDefinitions

public java.lang.Iterable<NodeDefinition> getAutoCreateNodeDefinitions()

getAutoCreatePropertyDefinitions

public java.lang.Iterable<PropertyDefinition> getAutoCreatePropertyDefinitions()

getMandatoryNodeDefinitions

public java.lang.Iterable<NodeDefinition> getMandatoryNodeDefinitions()

getMandatoryPropertyDefinitions

public java.lang.Iterable<PropertyDefinition> getMandatoryPropertyDefinitions()

getNamedNodeDefinitions

public java.lang.Iterable<NodeDefinition> getNamedNodeDefinitions(java.lang.String oakName)

Return all node definitions that match the specified oak name.

Parameters:

oakName - An internal oak name.

Returns:

All node definitions that match the given internal oak name.

getNamedPropertyDefinitions

public java.lang.Iterable<PropertyDefinition> getNamedPropertyDefinitions(java.lang.String oakName)

Return all property definitions that match the specified oak name.

Parameters:

oakName - An internal oak name.

Returns:

All property definitions that match the given internal oak name.

getResidualNodeDefinitions

public java.lang.Iterable<NodeDefinition> getResidualNodeDefinitions()

Return all residual node definitions.

Returns:

All residual node definitions.

getResidualPropertyDefinitions

public java.lang.Iterable<PropertyDefinition> getResidualPropertyDefinitions()

Return all residual property definitions.

Returns:

All residual property definitions.

checkSetProperty

public void checkSetProperty(PropertyState property)
                      throws RepositoryException

Throws:

RepositoryException

checkRemoveProperty

public void checkRemoveProperty(PropertyState property)
                         throws RepositoryException

Throws:

RepositoryException

checkMandatoryItems

public void checkMandatoryItems(Tree tree)
                         throws ConstraintViolationException

Throws:

ConstraintViolationException

checkOrderableChildNodes

public void checkOrderableChildNodes()
                              throws UnsupportedRepositoryOperationException

Throws:

UnsupportedRepositoryOperationException

getPropertyDefinition

public PropertyDefinition getPropertyDefinition(java.lang.String propertyName,
                                                boolean isMultiple,
                                                int type,
                                                boolean exactTypeMatch)
                                         throws ConstraintViolationException

Calculates the applicable definition for the property with the specified characteristics under a parent with this effective type.

Parameters:

propertyName - The internal oak name of the property for which the definition should be retrieved.

isMultiple - true if the target property is multi-valued.

type - The target type of the property.

exactTypeMatch - true if the required type of the definition must exactly match the type of the target property.

Returns:

the applicable definition for the target property.

Throws:

ConstraintViolationException - If no matching definition can be found.

RepositoryException - If another error occurs.

getNodeDefinition

public NodeDefinition getNodeDefinition(java.lang.String childName,
                                        EffectiveNodeType childEffective)
                                 throws ConstraintViolationException

Parameters:

childName - The internal oak name of the target node.

childEffective -

Returns:

the node definition

Throws:

ConstraintViolationException