org.apache.manifoldcf.core.interfaces

Class Specification

java.lang.Object

org.apache.manifoldcf.core.interfaces.Configuration

org.apache.manifoldcf.core.interfaces.Specification

All Implemented Interfaces:

IHierarchyParent

public class Specification
extends Configuration

This class represents a specification, which is a generalized hierarchy of nodes that can be interpreted by an appropriate connector in an appropriate way.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.manifoldcf.core.interfaces.Configuration

Configuration.JSONReader, Configuration.JSONWriter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_rcsid

Fields inherited from class org.apache.manifoldcf.core.interfaces.Configuration

children, JSON_ATTRIBUTE, JSON_CHILDREN, JSON_TYPE, JSON_VALUE, readOnly, rootNodeLabel

Constructor Summary

Constructors

Constructor and Description
Specification() Constructor.
Specification(java.lang.String xml) Construct from XML.

Method Summary

Modifier and Type	Method and Description
protected Configuration	createNew() Create a new object of the appropriate class.
protected ConfigurationNode	createNewNode(java.lang.String type) Create a new child node of the appropriate type and class.
Specification	duplicate(boolean readOnly) Duplicate.
SpecificationNode	getChild(int index) Get child n.

Methods inherited from class org.apache.manifoldcf.core.interfaces.Configuration

addChild, addOuterNode, clearChildren, clearOuterNodes, createDuplicate, equals, findChild, fromJSON, fromXML, fromXML, getChildCount, hashCode, initializeFromDoc, makeReadOnly, processObject, processObject, readNode, readNode, removeChild, removeOuterNode, toJSON, toString, toXML, writeNode, writeNode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

_rcsid

public static final java.lang.String _rcsid

See Also:

Constant Field Values

Constructor Detail

Specification

public Specification()

Constructor.

Specification

public Specification(java.lang.String xml)
              throws ManifoldCFException

Construct from XML.

Parameters:

xml - is the input XML.

Throws:

ManifoldCFException

Method Detail

createNew

protected Configuration createNew()

Create a new object of the appropriate class.

Overrides:

createNew in class Configuration

Returns:

the newly-created configuration object.

createNewNode

protected ConfigurationNode createNewNode(java.lang.String type)

Create a new child node of the appropriate type and class.

Overrides:

createNewNode in class Configuration

Returns:

the newly-created node.

getChild

public SpecificationNode getChild(int index)

Get child n.

Parameters:

index - is the child number.

Returns:

the child node.

duplicate

public Specification duplicate(boolean readOnly)

Duplicate.

Returns:

an exact duplicate