Package org.apache.jackrabbit.spi.commons.nodetype

Class NodeTypeTemplateImpl

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      NodeDefinition[] getDeclaredChildNodeDefinitions()
      Returns an array containing the child node definitions actually declared in this node type.
      PropertyDefinition[] getDeclaredPropertyDefinitions()
      Returns an array containing the property definitions actually declared in this node type.
      java.lang.String[] getDeclaredSupertypeNames()
      Returns the names of the supertypes actually declared in this node type.
      java.lang.String getName()
      Returns the name of the node type.
      java.util.List getNodeDefinitionTemplates()
      Returns a mutable List of NodeDefinitionTemplate objects.
      java.lang.String getPrimaryItemName()
      Returns the name of the primary item (one of the child items of the nodes of this node type).
      java.util.List getPropertyDefinitionTemplates()
      Returns a mutable List of PropertyDefinitionTemplate objects.
      boolean hasOrderableChildNodes()
      Returns true if nodes of this type must support orderable child nodes; returns false otherwise.
      boolean isAbstract()
      Returns true if this is an abstract node type; returns false otherwise.
      boolean isMixin()
      Returns true if this is a mixin type; returns false if it is primary.
      boolean isQueryable()
      Returns true if the node type is queryable, meaning that the available-query-operators, full-text-searchable and query-orderable attributes of its property definitions take effect.
      void setAbstract​(boolean abstractStatus)
      Sets the abstract flag of the node type.
      void setDeclaredSuperTypeNames​(java.lang.String[] names)
      Sets the names of the supertypes of the node type.
      void setMixin​(boolean mixin)
      Sets the mixin flag of the node type.
      void setName​(java.lang.String name)
      Sets the name of the node type.
      void setOrderableChildNodes​(boolean orderable)
      Sets the orderable child nodes flag of the node type.
      void setPrimaryItemName​(java.lang.String name)
      Sets the name of the primary item.
      void setQueryable​(boolean queryable)
      Sets the queryable status of the node type.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • setName

        public void setName​(java.lang.String name)
             throws ConstraintViolationException
        Sets the name of the node type. This must be a JCR name in either qualified or expanded form.
        Specified by:
        setName in interface NodeTypeTemplate
        Parameters:
        name - a JCR name.
        Throws:
        ConstraintViolationException - if name is not a syntactically valid JCR name in either qualified or expanded form.

      • setDeclaredSuperTypeNames

        public void setDeclaredSuperTypeNames​(java.lang.String[] names)
                               throws ConstraintViolationException
        Sets the names of the supertypes of the node type. These must be a JCR names in either qualified or expanded form.
        Specified by:
        setDeclaredSuperTypeNames in interface NodeTypeTemplate
        Parameters:
        names - an array of JCR names.
        Throws:
        ConstraintViolationException - if names includes a name that is not a syntactically valid JCR name in either qualified or expanded form.

      • setAbstract

        public void setAbstract​(boolean abstractStatus)
        Sets the abstract flag of the node type.
        Specified by:
        setAbstract in interface NodeTypeTemplate
        Parameters:
        abstractStatus - a boolean.

      • setMixin

        public void setMixin​(boolean mixin)
        Sets the mixin flag of the node type.
        Specified by:
        setMixin in interface NodeTypeTemplate
        Parameters:
        mixin - a boolean.

      • setOrderableChildNodes

        public void setOrderableChildNodes​(boolean orderable)
        Sets the orderable child nodes flag of the node type.
        Specified by:
        setOrderableChildNodes in interface NodeTypeTemplate
        Parameters:
        orderable - a boolean.

      • getPropertyDefinitionTemplates

        public java.util.List getPropertyDefinitionTemplates()
        Returns a mutable List of PropertyDefinitionTemplate objects. To define a new NodeTypeTemplate or change an existing one, PropertyDefinitionTemplate objects can be added to or removed from this List.
        Specified by:
        getPropertyDefinitionTemplates in interface NodeTypeTemplate
        Returns:
        a mutable List of PropertyDefinitionTemplate objects.

      • getNodeDefinitionTemplates

        public java.util.List getNodeDefinitionTemplates()
        Returns a mutable List of NodeDefinitionTemplate objects. To define a new NodeTypeTemplate or change an existing one, NodeDefinitionTemplate objects can be added to or removed from this List.
        Specified by:
        getNodeDefinitionTemplates in interface NodeTypeTemplate
        Returns:
        a mutable List of NodeDefinitionTemplate objects.

      • setQueryable

        public void setQueryable​(boolean queryable)
        Sets the queryable status of the node type.
        Specified by:
        setQueryable in interface NodeTypeTemplate
        Parameters:
        queryable - a boolean.

      • getName

        public java.lang.String getName()
        Returns the name of the node type.

        In implementations that support node type registration, if this NodeTypeDefinition object is actually a newly-created empty NodeTypeTemplate, then this method will return null.

        Specified by:
        getName in interface NodeTypeDefinition
        Returns:
        a String

      • getDeclaredSupertypeNames

        public java.lang.String[] getDeclaredSupertypeNames()
        Returns the names of the supertypes actually declared in this node type.

        In implementations that support node type registration, if this NodeTypeDefinition object is actually a newly-created empty NodeTypeTemplate, then this method will return an empty array.

        Specified by:
        getDeclaredSupertypeNames in interface NodeTypeDefinition
        Returns:
        an array of Strings

      • isAbstract

        public boolean isAbstract()
        Returns true if this is an abstract node type; returns false otherwise.

        An abstract node type is one that cannot be assigned as the primary or mixin type of a node but can be used in the definitions of other node types as a superclass.

        In implementations that support node type registration, if this NodeTypeDefinition object is actually a newly-created empty NodeTypeTemplate, then this method will return false.

        Specified by:
        isAbstract in interface NodeTypeDefinition
        Returns:
        a boolean

      • isMixin

        public boolean isMixin()
        Returns true if this is a mixin type; returns false if it is primary.

        In implementations that support node type registration, if this NodeTypeDefinition object is actually a newly-created empty NodeTypeTemplate, then this method will return false.

        Specified by:
        isMixin in interface NodeTypeDefinition
        Returns:
        a boolean

      • hasOrderableChildNodes

        public boolean hasOrderableChildNodes()
        Returns true if nodes of this type must support orderable child nodes; returns false otherwise. If a node type returns true on a call to this method, then all nodes of that node type must support the method Node.orderBefore. If a node type returns false on a call to this method, then nodes of that node type may support Node.orderBefore. Only the primary node type of a node controls that node's status in this regard. This setting on a mixin node type will not have any effect on the node.

        In implementations that support node type registration, if this NodeTypeDefinition object is actually a newly-created empty NodeTypeTemplate, then this method will return false.

        Specified by:
        hasOrderableChildNodes in interface NodeTypeDefinition
        Returns:
        a boolean

      • getPrimaryItemName

        public java.lang.String getPrimaryItemName()
        Returns the name of the primary item (one of the child items of the nodes of this node type). If this node has no primary item, then this method returns null. This indicator is used by the method Node.getPrimaryItem().

        In implementations that support node type registration, if this NodeTypeDefinition object is actually a newly-created empty NodeTypeTemplate, then this method will return null.

        Specified by:
        getPrimaryItemName in interface NodeTypeDefinition
        Returns:
        a String

      • getDeclaredPropertyDefinitions

        public PropertyDefinition[] getDeclaredPropertyDefinitions()
        Returns an array containing the property definitions actually declared in this node type.

        In implementations that support node type registration, if this NodeTypeDefinition object is actually a newly-created empty NodeTypeTemplate, then this method will return null.

        Specified by:
        getDeclaredPropertyDefinitions in interface NodeTypeDefinition
        Returns:
        an array of PropertyDefinitions

      • getDeclaredChildNodeDefinitions

        public NodeDefinition[] getDeclaredChildNodeDefinitions()
        Returns an array containing the child node definitions actually declared in this node type.

        In implementations that support node type registration, if this NodeTypeDefinition object is actually a newly-created empty NodeTypeTemplate, then this method will return null.

        Specified by:
        getDeclaredChildNodeDefinitions in interface NodeTypeDefinition
        Returns:
        an array of NodeDefinitions