org.apache.jackrabbit.core.nodetype.xml

Class NodeTypeReader

java.lang.Object

org.apache.jackrabbit.core.nodetype.xml.NodeTypeReader

public class NodeTypeReader
extends Object

Node type definition reader. This class is used to read the persistent node type definition files used by Jackrabbit.

Constructor Summary

Constructors

Constructor and Description
NodeTypeReader(InputStream xml) Creates a node type definition file reader.

Method Summary

Modifier and Type	Method and Description
Properties	getNamespaces() Returns the namespaces declared in the node type definition file.
org.apache.jackrabbit.spi.QNodeTypeDefinition[]	getNodeTypeDefs() Returns all node type definitions specified by node type elements under the current element.
static org.apache.jackrabbit.spi.QNodeTypeDefinition[]	read(InputStream xml) Reads a node type definition file.

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeTypeReader

public NodeTypeReader(InputStream xml)
               throws IOException

Creates a node type definition file reader.

Parameters:

xml - node type definition file

Throws:

IOException - if the node type definition file cannot be read

Method Detail

read

public static org.apache.jackrabbit.spi.QNodeTypeDefinition[] read(InputStream xml)
                                                            throws IOException,
                                                                   InvalidNodeTypeDefException

Reads a node type definition file. The file contents are read from the given input stream and the parsed node type definitions are returned.

Parameters:

xml - XML input stream

Returns:

node type definitions

Throws:

IOException - if the node type definitions cannot be read

InvalidNodeTypeDefException - if the node type definition format is invalid

getNamespaces

public Properties getNamespaces()

Returns the namespaces declared in the node type definition file.

Returns:

the namespaces

getNodeTypeDefs

public org.apache.jackrabbit.spi.QNodeTypeDefinition[] getNodeTypeDefs()
                                                                throws InvalidNodeTypeDefException,
                                                                       org.apache.jackrabbit.spi.commons.conversion.NameException,
                                                                       NamespaceException

Returns all node type definitions specified by node type elements under the current element.

Returns:

node type definitions

Throws:

InvalidNodeTypeDefException - if a definition is invalid

org.apache.jackrabbit.spi.commons.conversion.NameException - if a definition contains an illegal name

NamespaceException - if a namespace is not defined