Package org.apache.jackrabbit.oak.spi.nodetype

Interface DefinitionProvider

  • @ProviderType
public interface DefinitionProvider
    DefinitionProvider... TODO

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      @NotNull javax.jcr.nodetype.NodeDefinition getDefinition​(@NotNull org.apache.jackrabbit.oak.api.Tree parent, @NotNull java.lang.String nodeName)
      Returns the node definition for a child node of parent named nodeName with a default primary type.
      @NotNull javax.jcr.nodetype.PropertyDefinition getDefinition​(@NotNull org.apache.jackrabbit.oak.api.Tree parent, @NotNull org.apache.jackrabbit.oak.api.PropertyState propertyState, boolean exactTypeMatch)
      Calculates the applicable definition for the property state under the given parent tree.
      @NotNull javax.jcr.nodetype.NodeDefinition getDefinition​(@NotNull org.apache.jackrabbit.oak.api.Tree parent, @NotNull org.apache.jackrabbit.oak.api.Tree targetNode)
      Calculates the applicable definition for the child node under the given parent node.
      @NotNull javax.jcr.nodetype.NodeDefinition getRootDefinition()  

    • Method Detail

      • getRootDefinition

        @NotNull
@NotNull javax.jcr.nodetype.NodeDefinition getRootDefinition()
                                                      throws javax.jcr.RepositoryException
        Throws:
        javax.jcr.RepositoryException

      • getDefinition

        @NotNull
@NotNull javax.jcr.nodetype.NodeDefinition getDefinition​(@NotNull
                                                         @NotNull org.apache.jackrabbit.oak.api.Tree parent,
                                                         @NotNull
                                                         @NotNull java.lang.String nodeName)
                                                  throws javax.jcr.nodetype.ConstraintViolationException,
                                                         javax.jcr.RepositoryException
        Returns the node definition for a child node of parent named nodeName with a default primary type. First the non-residual child node definitions of parent are checked matching the given node name. Then the residual definitions are checked.
        Parameters:
        parent - the parent node.
        nodeName - The internal oak name of the child node.
        Returns:
        the applicable node definition.
        Throws:
        javax.jcr.nodetype.ConstraintViolationException - If no matching definition can be found.
        javax.jcr.RepositoryException - If another error occurs.

      • getDefinition

        @NotNull
@NotNull javax.jcr.nodetype.NodeDefinition getDefinition​(@NotNull
                                                         @NotNull org.apache.jackrabbit.oak.api.Tree parent,
                                                         @NotNull
                                                         @NotNull org.apache.jackrabbit.oak.api.Tree targetNode)
                                                  throws javax.jcr.nodetype.ConstraintViolationException,
                                                         javax.jcr.RepositoryException
        Calculates the applicable definition for the child node under the given parent node.
        Parameters:
        parent - The parent node.
        targetNode - The child node for which the definition is calculated.
        Returns:
        the definition of the target node.
        Throws:
        javax.jcr.nodetype.ConstraintViolationException - If no matching definition can be found.
        javax.jcr.RepositoryException - If another error occurs.

      • getDefinition

        @NotNull
@NotNull javax.jcr.nodetype.PropertyDefinition getDefinition​(@NotNull
                                                             @NotNull org.apache.jackrabbit.oak.api.Tree parent,
                                                             @NotNull
                                                             @NotNull org.apache.jackrabbit.oak.api.PropertyState propertyState,
                                                             boolean exactTypeMatch)
                                                      throws javax.jcr.nodetype.ConstraintViolationException,
                                                             javax.jcr.RepositoryException
        Calculates the applicable definition for the property state under the given parent tree.
        Parameters:
        parent - The parent tree.
        propertyState - The target property.
        Returns:
        the definition for the target property.
        Throws:
        javax.jcr.nodetype.ConstraintViolationException - If no matching definition can be found.
        javax.jcr.RepositoryException - If another error occurs.