org.apache.jackrabbit.spi
Interface QNodeTypeDefinition

All Known Implementing Classes:
QNodeTypeDefinitionImpl

public interface QNodeTypeDefinition

QNodeTypeDefinition is the qualified SPI representation of a node type. It refers to qualified names only and is therefore independant of session-specific namespace mappings.

See Also:
NodeType

Method Summary
 QNodeDefinition[] getChildNodeDefs()
          Returns an array containing the child node definitions or null if not set.
 Collection getDependencies()
          Returns a collection of node type Names that are being referenced by this node type definition (e.g.
 Name getName()
          Returns the name of the node type being defined or null if not set.
 Name getPrimaryItemName()
          Returns the name of the primary item (one of the child items of the node's of this node type) or null if not set.
 QPropertyDefinition[] getPropertyDefs()
          Returns an array containing the property definitions or null if not set.
 Name[] getSupertypes()
          Returns an array containing the names of the supertypes.
 boolean hasOrderableChildNodes()
          Returns the value of the orderableChildNodes flag.
 boolean isMixin()
          Returns the value of the mixin flag.
 

Method Detail

getName

Name getName()
Returns the name of the node type being defined or null if not set.

Returns:
the name of the node type or null if not set.

getSupertypes

Name[] getSupertypes()
Returns an array containing the names of the supertypes. If no supertypes have been specified, then an empty array is returned for mixin types and the nt:base primary type and an array containing just nt:base for other primary types.

The returned array must not be modified by the application.

Returns:
an array of supertype names

isMixin

boolean isMixin()
Returns the value of the mixin flag.

Returns:
true if this is a mixin node type; false otherwise.

hasOrderableChildNodes

boolean hasOrderableChildNodes()
Returns the value of the orderableChildNodes flag.

Returns:
true if nodes of this node type can have orderable child nodes; false otherwise.

getPrimaryItemName

Name getPrimaryItemName()
Returns the name of the primary item (one of the child items of the node's of this node type) or null if not set.

Returns:
the name of the primary item or null if not set.

getPropertyDefs

QPropertyDefinition[] getPropertyDefs()
Returns an array containing the property definitions or null if not set.

Returns:
an array containing the property definitions or null if not set.

getChildNodeDefs

QNodeDefinition[] getChildNodeDefs()
Returns an array containing the child node definitions or null if not set.

Returns:
an array containing the child node definitions or null if not set.

getDependencies

Collection getDependencies()
Returns a collection of node type Names that are being referenced by this node type definition (e.g. as supertypes, as required/default primary types in child node definitions, as REFERENCE value constraints in property definitions).

Note that self-references (e.g. a child node definition that specifies the declaring node type as the default primary type) are not considered dependencies.

Returns:
a collection of node type Names


Copyright © 2004-2008 The Apache Software Foundation. All Rights Reserved.