org.apache.jackrabbit.jcr2spi.nodetype
Interface NodeTypeRegistry

All Known Implementing Classes:

NodeTypeRegistryImpl

public interface NodeTypeRegistry

NodeTypeRegistry...

Method Summary

void	addListener(NodeTypeRegistryListener listener) Add a NodeTypeRegistryListener
QNodeTypeDefinition	getNodeTypeDefinition(Name nodeTypeName) Returns the node type definition of the node type with the given name.
Name[]	getRegisteredNodeTypes() Returns the names of all registered node types.
boolean	isRegistered(Name ntName)
EffectiveNodeType	registerNodeType(QNodeTypeDefinition ntDef) Validates the NodeTypeDef and returns a registered EffectiveNodeType instance.
void	registerNodeTypes(java.util.Collection ntDefs) Same as registerNodeType(QNodeTypeDefinition) except that a collection of NodeTypeDefs is registered instead of just one.
void	removeListener(NodeTypeRegistryListener listener) Remove a NodeTypeRegistryListener
EffectiveNodeType	reregisterNodeType(QNodeTypeDefinition ntd)
void	unregisterNodeType(Name nodeTypeName)
void	unregisterNodeTypes(java.util.Collection nodeTypeNames) Same as unregisterNodeType(Name) except that a set of node types is unregistered instead of just one.

Method Detail

getNodeTypeDefinition

QNodeTypeDefinition getNodeTypeDefinition(Name nodeTypeName)
                                          throws javax.jcr.nodetype.NoSuchNodeTypeException

Returns the node type definition of the node type with the given name.

Parameters:

nodeTypeName - name of node type whose definition should be returned.

Returns:

the node type definition of the node type with the given name.

Throws:

javax.jcr.nodetype.NoSuchNodeTypeException - if a node type with the given name does not exist

addListener

void addListener(NodeTypeRegistryListener listener)

Add a NodeTypeRegistryListener

Parameters:

listener - the new listener to be informed on (un)registration of node types

removeListener

void removeListener(NodeTypeRegistryListener listener)

Remove a NodeTypeRegistryListener

Parameters:

listener - an existing listener

isRegistered

boolean isRegistered(Name ntName)

Parameters:

ntName -

Returns:

getRegisteredNodeTypes

Name[] getRegisteredNodeTypes()
                              throws javax.jcr.RepositoryException

Returns the names of all registered node types. That includes primary and mixin node types.

Returns:

the names of all registered node types.

Throws:

javax.jcr.RepositoryException

registerNodeType

EffectiveNodeType registerNodeType(QNodeTypeDefinition ntDef)
                                   throws InvalidNodeTypeDefException,
                                          javax.jcr.RepositoryException

Validates the NodeTypeDef and returns a registered EffectiveNodeType instance.

The validation includes the following checks:

• Supertypes must exist and be registered
• Inheritance graph must not be circular
• Aggregation of supertypes must not result in name conflicts, ambiguities, etc.
• Definitions of auto-created properties must specify a name
• Default values in property definitions must satisfy value constraints specified in the same property definition
• Definitions of auto-created child-nodes must specify a name
• Default node type in child-node definitions must exist and be registered
• The aggregation of the default node types in child-node definitions must not result in name conflicts, ambiguities, etc.
• Definitions of auto-created child-nodes must not specify default node types which would lead to infinite child node creation (e.g. node type 'A' defines auto-created child node with default node type 'A' ...)
• Node types specified as constraints in child-node definitions must exist and be registered
• The aggregation of the node types specified as constraints in child-node definitions must not result in name conflicts, ambiguities, etc.
• Default node types in child-node definitions must satisfy node type constraints specified in the same child-node definition

Parameters:

ntDef - the definition of the new node type

Returns:

an EffectiveNodeType instance

Throws:

InvalidNodeTypeDefException

javax.jcr.RepositoryException

registerNodeTypes

void registerNodeTypes(java.util.Collection ntDefs)
                       throws InvalidNodeTypeDefException,
                              javax.jcr.RepositoryException

Same as registerNodeType(QNodeTypeDefinition) except that a collection of NodeTypeDefs is registered instead of just one.

This method can be used to register a set of node types that have dependencies on each other.

Note that in the case an exception is thrown, some node types might have been nevertheless successfully registered.

Parameters:

ntDefs - a collection of NodeTypeDefs

Throws:

InvalidNodeTypeDefException

javax.jcr.RepositoryException

unregisterNodeType

void unregisterNodeType(Name nodeTypeName)
                        throws javax.jcr.nodetype.NoSuchNodeTypeException,
                               javax.jcr.RepositoryException

Parameters:

nodeTypeName -

Throws:

javax.jcr.nodetype.NoSuchNodeTypeException

javax.jcr.RepositoryException

unregisterNodeTypes

void unregisterNodeTypes(java.util.Collection nodeTypeNames)
                         throws javax.jcr.nodetype.NoSuchNodeTypeException,
                                javax.jcr.RepositoryException

Same as unregisterNodeType(Name) except that a set of node types is unregistered instead of just one.

This method can be used to unregister a set of node types that depend on each other.

Parameters:

nodeTypeNames - a collection of Name objects denoting the node types to be unregistered

Throws:

javax.jcr.nodetype.NoSuchNodeTypeException - if any of the specified names does not denote a registered node type.

javax.jcr.RepositoryException - if another error occurs

See Also:

unregisterNodeType(Name)

reregisterNodeType

EffectiveNodeType reregisterNodeType(QNodeTypeDefinition ntd)
                                     throws javax.jcr.nodetype.NoSuchNodeTypeException,
                                            InvalidNodeTypeDefException,
                                            javax.jcr.RepositoryException

Parameters:

ntd -

Returns:

Throws:

javax.jcr.nodetype.NoSuchNodeTypeException

InvalidNodeTypeDefException

javax.jcr.RepositoryException