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

Class NodeTypeDefinitionImpl

java.lang.Object

org.apache.jackrabbit.spi.commons.nodetype.NodeTypeDefinitionImpl

All Implemented Interfaces:

NodeTypeDefinition

public class NodeTypeDefinitionImpl
extends Object
implements NodeTypeDefinition

AbstractNodeTypeDefinition...

Constructor Summary

Constructors

Constructor	Description
NodeTypeDefinitionImpl(QNodeTypeDefinition ntd, NamePathResolver resolver, ValueFactory valueFactory)

Method Summary

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.
String[]	getDeclaredSupertypeNames()	Returns the names of the supertypes actually declared in this node type.
String	getName()	Returns the name of the node type.
String	getPrimaryItemName()	Returns the name of the primary item (one of the child items of the nodes of this node type).
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeTypeDefinitionImpl

public NodeTypeDefinitionImpl(QNodeTypeDefinition ntd,
                              NamePathResolver resolver,
                              ValueFactory valueFactory)

Parameters:

ntd -

resolver -

valueFactory -

Method Detail

getName

public String getName()

Description copied from interface: NodeTypeDefinition

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

See Also:

NodeTypeDefinition.getName()

getPrimaryItemName

public String getPrimaryItemName()

Description copied from interface: NodeTypeDefinition

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

See Also:

NodeTypeDefinition.getPrimaryItemName()

isMixin

public boolean isMixin()

Description copied from interface: NodeTypeDefinition

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

See Also:

NodeTypeDefinition.isMixin()

hasOrderableChildNodes

public boolean hasOrderableChildNodes()

Description copied from interface: NodeTypeDefinition

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

See Also:

NodeTypeDefinition.hasOrderableChildNodes()

isAbstract

public boolean isAbstract()

Description copied from interface: NodeTypeDefinition

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

See Also:

NodeTypeDefinition.isAbstract()

isQueryable

public boolean isQueryable()

Description copied from interface: NodeTypeDefinition

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. See PropertyDefinition.getAvailableQueryOperators(), PropertyDefinition.isFullTextSearchable() and PropertyDefinition.isQueryOrderable().

If a node type is declared non-queryable then these attributes of its property definitions have no effect.

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

Specified by:

isQueryable in interface NodeTypeDefinition

Returns:

a boolean

See Also:

NodeTypeDefinition.isQueryable()

getDeclaredPropertyDefinitions

public PropertyDefinition[] getDeclaredPropertyDefinitions()

Description copied from interface: NodeTypeDefinition

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

See Also:

NodeTypeDefinition.getDeclaredPropertyDefinitions()

getDeclaredChildNodeDefinitions

public NodeDefinition[] getDeclaredChildNodeDefinitions()

Description copied from interface: NodeTypeDefinition

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

See Also:

NodeTypeDefinition.getDeclaredChildNodeDefinitions()

getDeclaredSupertypeNames

public String[] getDeclaredSupertypeNames()

Description copied from interface: NodeTypeDefinition

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

See Also:

NodeTypeDefinition.getDeclaredSupertypeNames()