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

Class AbstractNodeTypeManager

java.lang.Object

org.apache.jackrabbit.spi.commons.nodetype.AbstractNodeTypeManager

All Implemented Interfaces:

NodeTypeManager

public abstract class AbstractNodeTypeManager
extends Object
implements NodeTypeManager

AbstractNodeTypeManager covers creation of node type templates and definition templates.

Constructor Summary

Constructors

Constructor	Description
AbstractNodeTypeManager()

Method Summary

Modifier and Type	Method	Description
NodeDefinitionTemplate	createNodeDefinitionTemplate()	Returns an empty NodeDefinitionTemplate which can then be used to create a child node definition and attached to a NodeTypeTemplate.
NodeTypeTemplate	createNodeTypeTemplate()	Returns an empty NodeTypeTemplate which can then be used to define a node type and passed to NodeTypeManager.registerNodeType.
NodeTypeTemplate	createNodeTypeTemplate(NodeTypeDefinition ntd)	Returns a NodeTypeTemplate holding the specified node type definition.
PropertyDefinitionTemplate	createPropertyDefinitionTemplate()	Returns an empty PropertyDefinitionTemplate which can then be used to create a property definition and attached to a NodeTypeTemplate.
abstract NamePathResolver	getNamePathResolver()	Returns the NamePathResolver used to validate JCR names.
abstract NodeDefinition	getNodeDefinition(QNodeDefinition nd)	Retrieve the NodeDefinition for the given QNodeDefinition.
abstract NodeType	getNodeType(Name ntName)	Return the node type with the specified ntName.
abstract PropertyDefinition	getPropertyDefinition(QPropertyDefinition pd)	Retrieve the PropertyDefinition for the given QPropertyDefinition.
NodeType	registerNodeType(NodeTypeDefinition ntd, boolean allowUpdate)	Registers a new node type or updates an existing node type using the specified definition and returns the resulting NodeType object.
void	unregisterNodeType(String name)	Unregisters the specified node type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.jcr.nodetype.NodeTypeManager

getAllNodeTypes, getMixinNodeTypes, getNodeType, getPrimaryNodeTypes, hasNodeType, registerNodeTypes, unregisterNodeTypes

Constructor Detail

AbstractNodeTypeManager

public AbstractNodeTypeManager()

Method Detail

getNodeType

public abstract NodeType getNodeType(Name ntName)
                              throws NoSuchNodeTypeException

Return the node type with the specified ntName.

Parameters:

ntName - Name of the node type to be returned.

Returns:

the node type with the specified ntName.

Throws:

NoSuchNodeTypeException - If no such node type exists.

getNodeDefinition

public abstract NodeDefinition getNodeDefinition(QNodeDefinition nd)

Retrieve the NodeDefinition for the given QNodeDefinition.

Parameters:

nd - the QNodeDefinition.

Returns:

the node definition.

getPropertyDefinition

public abstract PropertyDefinition getPropertyDefinition(QPropertyDefinition pd)

Retrieve the PropertyDefinition for the given QPropertyDefinition.

Parameters:

pd - the QPropertyDefinition.

Returns:

the property definition.

getNamePathResolver

public abstract NamePathResolver getNamePathResolver()

Returns the NamePathResolver used to validate JCR names.

Returns:

the NamePathResolver used to convert JCR names/paths to internal onces and vice versa. The resolver may also be used to validate names passed to the various templates.

createNodeTypeTemplate

public NodeTypeTemplate createNodeTypeTemplate()
                                        throws UnsupportedRepositoryOperationException,
                                               RepositoryException

Description copied from interface: NodeTypeManager

Returns an empty NodeTypeTemplate which can then be used to define a node type and passed to NodeTypeManager.registerNodeType.

Specified by:

createNodeTypeTemplate in interface NodeTypeManager

Returns:

A NodeTypeTemplate.

Throws:

UnsupportedRepositoryOperationException - if this implementation does not support node type registration.

RepositoryException - if another error occurs.

See Also:

NodeTypeManager.createNodeTypeTemplate()

createNodeTypeTemplate

public NodeTypeTemplate createNodeTypeTemplate(NodeTypeDefinition ntd)
                                        throws UnsupportedRepositoryOperationException,
                                               RepositoryException

Description copied from interface: NodeTypeManager

Returns a NodeTypeTemplate holding the specified node type definition. This template can then be altered and passed to NodeTypeManager.registerNodeType.

Specified by:

createNodeTypeTemplate in interface NodeTypeManager

Parameters:

ntd - a NodeTypeDefinition.

Returns:

A NodeTypeTemplate.

Throws:

UnsupportedRepositoryOperationException - if this implementation does not support node type registration.

RepositoryException - if another error occurs.

See Also:

NodeTypeManager.createNodeTypeTemplate(NodeTypeDefinition)

createNodeDefinitionTemplate

public NodeDefinitionTemplate createNodeDefinitionTemplate()
                                                    throws UnsupportedRepositoryOperationException,
                                                           RepositoryException

Description copied from interface: NodeTypeManager

Returns an empty NodeDefinitionTemplate which can then be used to create a child node definition and attached to a NodeTypeTemplate.

Specified by:

createNodeDefinitionTemplate in interface NodeTypeManager

Returns:

A NodeDefinitionTemplate.

Throws:

UnsupportedRepositoryOperationException - if this implementation does not support node type registration.

RepositoryException - if another error occurs.

See Also:

NodeTypeManager.createNodeDefinitionTemplate()

createPropertyDefinitionTemplate

public PropertyDefinitionTemplate createPropertyDefinitionTemplate()
                                                            throws UnsupportedRepositoryOperationException,
                                                                   RepositoryException

Description copied from interface: NodeTypeManager

Returns an empty PropertyDefinitionTemplate which can then be used to create a property definition and attached to a NodeTypeTemplate.

Specified by:

createPropertyDefinitionTemplate in interface NodeTypeManager

Returns:

A PropertyDefinitionTemplate.

Throws:

UnsupportedRepositoryOperationException - if this implementation does not support node type registration.

RepositoryException - if another error occurs.

See Also:

NodeTypeManager.createPropertyDefinitionTemplate()

registerNodeType

public NodeType registerNodeType(NodeTypeDefinition ntd,
                                 boolean allowUpdate)
                          throws RepositoryException

Description copied from interface: NodeTypeManager

Registers a new node type or updates an existing node type using the specified definition and returns the resulting NodeType object.

Typically, the object passed to this method will be a NodeTypeTemplate (a subclass of NodeTypeDefinition) acquired from NodeTypeManager.createNodeTypeTemplate and then filled-in with definition information.

Specified by:

registerNodeType in interface NodeTypeManager

Parameters:

ntd - an NodeTypeDefinition.

allowUpdate - a boolean

Returns:

the registered node type

Throws:

InvalidNodeTypeDefinitionException - if the NodeTypeDefinition is invalid.

NodeTypeExistsException - if allowUpdate is false and the NodeTypeDefinition specifies a node type name that is already registered.

UnsupportedRepositoryOperationException - if this implementation does not support node type registration.

RepositoryException - if another error occurs.

See Also:

NodeTypeManager.registerNodeType(NodeTypeDefinition, boolean)

unregisterNodeType

public void unregisterNodeType(String name)
                        throws UnsupportedRepositoryOperationException,
                               NoSuchNodeTypeException,
                               RepositoryException

Description copied from interface: NodeTypeManager

Unregisters the specified node type.

Specified by:

unregisterNodeType in interface NodeTypeManager

Parameters:

name - a String.

Throws:

UnsupportedRepositoryOperationException - if this implementation does not support node type registration.

NoSuchNodeTypeException - if no registered node type exists with the specified name.

RepositoryException - if another error occurs.

See Also:

NodeTypeManager.unregisterNodeType(String)