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

Interface NodeTypeStorage

All Known Implementing Classes:

NodeTypeStorageImpl

public interface NodeTypeStorage

NodeTypeStorage provides means for storing QNodeTypeDefinitions.

Method Summary

Modifier and Type	Method	Description
java.util.Iterator<QNodeTypeDefinition>	getAllDefinitions()	Returns an Iterator over all node type definitions registered.
java.util.Iterator<QNodeTypeDefinition>	getDefinitions(Name[] nodeTypeNames)	Returns the QNodeTypeDefinitions for the given node type names.
void	registerNodeTypes(QNodeTypeDefinition[] nodeTypeDefs, boolean allowUpdate)	Add all QNodeTypeDefinitions provided to the store.
void	unregisterNodeTypes(Name[] nodeTypeNames)	Remove all QNodeTypeDefinitions provided from the store.

Method Detail

getAllDefinitions

java.util.Iterator<QNodeTypeDefinition> getAllDefinitions()
                                                   throws javax.jcr.RepositoryException

Returns an Iterator over all node type definitions registered.

Returns:

Throws:

javax.jcr.RepositoryException

getDefinitions

java.util.Iterator<QNodeTypeDefinition> getDefinitions(Name[] nodeTypeNames)
                                                throws javax.jcr.nodetype.NoSuchNodeTypeException,
                                                       javax.jcr.RepositoryException

Returns the QNodeTypeDefinitions for the given node type names. The implementation is free to return additional definitions e.g. dependencies.

Parameters:

nodeTypeNames -

Returns:

Throws:

javax.jcr.nodetype.NoSuchNodeTypeException

javax.jcr.RepositoryException

registerNodeTypes

void registerNodeTypes(QNodeTypeDefinition[] nodeTypeDefs,
                       boolean allowUpdate)
                throws javax.jcr.RepositoryException,
                       javax.jcr.nodetype.NodeTypeExistsException

Add all QNodeTypeDefinitions provided to the store. If allowUpdate is true previously registered node QNodeTypeDefinitions will be overwritten.

Parameters:

nodeTypeDefs - QNodeTypeDefinitions to add to the store

allowUpdate - Whether to overwrite existing QNodeTypeDefinitions

Throws:

javax.jcr.RepositoryException

javax.jcr.nodetype.NodeTypeExistsException - If allowUpdate is true and a QNodeTypeDefinitions of that name already exists. In this case, none of the provided QNodeTypeDefinitions is registered.

unregisterNodeTypes

void unregisterNodeTypes(Name[] nodeTypeNames)
                  throws javax.jcr.nodetype.NoSuchNodeTypeException,
                         javax.jcr.RepositoryException

Remove all QNodeTypeDefinitions provided from the store.

Parameters:

nodeTypeNames - QNodeTypeDefinitions to remove from the store

Throws:

javax.jcr.RepositoryException

javax.jcr.nodetype.NoSuchNodeTypeException - If any of the QNodeTypeDefinitions does not exist. In this case none of the provided is unregistered.