Interface ItemDefinitionProvider
-
- All Known Implementing Classes:
ItemDefinitionProviderImpl
public interface ItemDefinitionProviderItemDefinitionProvider...
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description org.apache.jackrabbit.spi.QNodeDefinitiongetQNodeDefinition(EffectiveNodeType ent, org.apache.jackrabbit.spi.Name name, org.apache.jackrabbit.spi.Name nodeTypeName)Returns the applicable child node definition for a child node with the specified name and node type.org.apache.jackrabbit.spi.QNodeDefinitiongetQNodeDefinition(org.apache.jackrabbit.spi.Name[] parentNodeTypeNames, org.apache.jackrabbit.spi.Name name, org.apache.jackrabbit.spi.Name nodeTypeName)Returns the applicable child node definition for a child node with the specified name and node type.org.apache.jackrabbit.spi.QNodeDefinitiongetQNodeDefinition(org.apache.jackrabbit.spi.Name[] parentNodeTypeNames, org.apache.jackrabbit.spi.Name nodeName, org.apache.jackrabbit.spi.Name ntName, org.apache.jackrabbit.spi.NodeId nodeId)Returns theQNodeDefinitionfor the specified node state.org.apache.jackrabbit.spi.QPropertyDefinitiongetQPropertyDefinition(org.apache.jackrabbit.spi.Name[] parentNodeTypeNames, org.apache.jackrabbit.spi.Name name, int type)Returns the applicable property definition for a property with the specified name and type.org.apache.jackrabbit.spi.QPropertyDefinitiongetQPropertyDefinition(org.apache.jackrabbit.spi.Name[] parentNodeTypeNames, org.apache.jackrabbit.spi.Name name, int type, boolean multiValued)Returns the applicable property definition for a property with the specified name, type and multiValued characteristic.org.apache.jackrabbit.spi.QPropertyDefinitiongetQPropertyDefinition(org.apache.jackrabbit.spi.Name[] parentNodeTypeNames, org.apache.jackrabbit.spi.Name propertyName, int propertyType, boolean isMultiValued, org.apache.jackrabbit.spi.PropertyId propertyId)Returns theQPropertyDefinitionfor the specified parameters.org.apache.jackrabbit.spi.QPropertyDefinitiongetQPropertyDefinition(org.apache.jackrabbit.spi.Name ntName, org.apache.jackrabbit.spi.Name propName, int type, boolean multiValued)Returns the applicable property definition for a property with the specified name, type and multiValued characteristic.org.apache.jackrabbit.spi.QNodeDefinitiongetRootNodeDefinition()Returns theQNodeDefinitionfor the root node.
-
-
-
Method Detail
-
getRootNodeDefinition
org.apache.jackrabbit.spi.QNodeDefinition getRootNodeDefinition() throws RepositoryExceptionReturns theQNodeDefinitionfor the root node.- Returns:
- the
QNodeDefinitionfor the root node. - Throws:
RepositoryException
-
getQNodeDefinition
org.apache.jackrabbit.spi.QNodeDefinition getQNodeDefinition(org.apache.jackrabbit.spi.Name[] parentNodeTypeNames, org.apache.jackrabbit.spi.Name nodeName, org.apache.jackrabbit.spi.Name ntName, org.apache.jackrabbit.spi.NodeId nodeId) throws RepositoryExceptionReturns theQNodeDefinitionfor the specified node state.- Parameters:
parentNodeTypeNames-nodeName-ntName-nodeId-- Returns:
- the
QNodeDefinitionfor the specified node state. - Throws:
RepositoryException
-
getQNodeDefinition
org.apache.jackrabbit.spi.QNodeDefinition getQNodeDefinition(org.apache.jackrabbit.spi.Name[] parentNodeTypeNames, org.apache.jackrabbit.spi.Name name, org.apache.jackrabbit.spi.Name nodeTypeName) throws NoSuchNodeTypeException, ConstraintViolationExceptionReturns the applicable child node definition for a child node with the specified name and node type.- Parameters:
parentNodeTypeNames-name-nodeTypeName-- Returns:
- Throws:
NoSuchNodeTypeExceptionConstraintViolationException- if no applicable child node definition could be found
-
getQNodeDefinition
org.apache.jackrabbit.spi.QNodeDefinition getQNodeDefinition(EffectiveNodeType ent, org.apache.jackrabbit.spi.Name name, org.apache.jackrabbit.spi.Name nodeTypeName) throws NoSuchNodeTypeException, ConstraintViolationException
Returns the applicable child node definition for a child node with the specified name and node type.- Parameters:
ent-name-nodeTypeName-- Returns:
- Throws:
NoSuchNodeTypeExceptionConstraintViolationException- if no applicable child node definition could be found
-
getQPropertyDefinition
org.apache.jackrabbit.spi.QPropertyDefinition getQPropertyDefinition(org.apache.jackrabbit.spi.Name[] parentNodeTypeNames, org.apache.jackrabbit.spi.Name propertyName, int propertyType, boolean isMultiValued, org.apache.jackrabbit.spi.PropertyId propertyId) throws RepositoryExceptionReturns theQPropertyDefinitionfor the specified parameters.- Parameters:
parentNodeTypeNames-propertyName-propertyType-isMultiValued-propertyId- Used to retrieve the definition from the persistent layer if it cannot be determined from the information present.- Returns:
- Throws:
RepositoryException
-
getQPropertyDefinition
org.apache.jackrabbit.spi.QPropertyDefinition getQPropertyDefinition(org.apache.jackrabbit.spi.Name ntName, org.apache.jackrabbit.spi.Name propName, int type, boolean multiValued) throws ConstraintViolationException, NoSuchNodeTypeExceptionReturns the applicable property definition for a property with the specified name, type and multiValued characteristic. If there more than one applicable definitions that would apply to the given params a ConstraintViolationException is thrown.- Parameters:
ntName-propName-type-multiValued-- Returns:
- Throws:
NoSuchNodeTypeException- If no node type with namentNameexists.ConstraintViolationException- if no applicable property definition could be found
-
getQPropertyDefinition
org.apache.jackrabbit.spi.QPropertyDefinition getQPropertyDefinition(org.apache.jackrabbit.spi.Name[] parentNodeTypeNames, org.apache.jackrabbit.spi.Name name, int type, boolean multiValued) throws ConstraintViolationException, NoSuchNodeTypeExceptionReturns the applicable property definition for a property with the specified name, type and multiValued characteristic. If there more than one applicable definitions then the following rules are applied:- named definitions are preferred to residual definitions
- definitions with specific required type are preferred to definitions with required type UNDEFINED
- Parameters:
parentNodeTypeNames-name-type-multiValued-- Returns:
- Throws:
ConstraintViolationException- if no applicable property definition could be found.NoSuchNodeTypeException
-
getQPropertyDefinition
org.apache.jackrabbit.spi.QPropertyDefinition getQPropertyDefinition(org.apache.jackrabbit.spi.Name[] parentNodeTypeNames, org.apache.jackrabbit.spi.Name name, int type) throws ConstraintViolationException, NoSuchNodeTypeExceptionReturns the applicable property definition for a property with the specified name and type. The multiValued flag is not taken into account in the selection algorithm. Other thanthis method does not take the multiValued flag into account in the selection algorithm. If there more than one applicable definitions then the following rules are applied:getQPropertyDefinition(Name[], Name, int, boolean)- named definitions are preferred to residual definitions
- definitions with specific required type are preferred to definitions with required type UNDEFINED
- single-value definitions are preferred to multiple-value definitions
- Parameters:
parentNodeTypeNames-name-type-- Returns:
- Throws:
ConstraintViolationException- if no applicable property definition could be foundNoSuchNodeTypeException
-
-