com.exalead.mercury.component.config.descriptor

Class ComponentNode

java.lang.Object

com.exalead.mercury.component.config.descriptor.Item

com.exalead.mercury.component.config.descriptor.Node

com.exalead.mercury.component.config.descriptor.ComponentNode

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class ComponentNode
extends Node
implements com.exalead.util.Checkable, java.io.Serializable

Component node

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.mercury.component.config.descriptor.Node

Node.DefaultFieldValue, Node.DefaultNodeValue

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	componentConfigClassId
java.util.List<Descriptor>	descriptor

Fields inherited from class com.exalead.mercury.component.config.descriptor.Node

defaultFieldValue, defaultNodeValue, field, node

Fields inherited from class com.exalead.mercury.component.config.descriptor.Item

DEFAULT_IS_HIDDEN, DEFAULT_IS_MANDATORY, description, isHidden, isMandatory, name, ordering, title

Constructor Summary

Constructors

Constructor and Description
ComponentNode()
ComponentNode(ComponentNode o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this ComponentNode.
static ComponentNode	fromString(java.lang.String s) String representation of this ComponentNode.
java.lang.String	getComponentConfigClassId() Base Class/Interface id of the associated descriptors
java.util.List<Descriptor>	getDescriptor() Allowed components
ComponentNode	makeCopy() Creates and returns a deep copy of this ComponentNode.
static ComponentNode	readFrom(java.io.InputStream is) Read this ComponentNode from an XML fragment.
void	setComponentConfigClassId(java.lang.String componentConfigClassId) Base Class/Interface id of the associated descriptors
java.lang.String	toString() String representation of this ComponentNode.
ComponentNode	withComponentConfigClassId(java.lang.String componentConfigClassId)
ComponentNode	withDefaultFieldValue(java.util.Collection<Field> __values)
ComponentNode	withDefaultFieldValue(Field... __values) Field default values
ComponentNode	withDefaultNodeValue(java.util.Collection<Node> __values)
ComponentNode	withDefaultNodeValue(Node... __values) Node default values (recursive)
ComponentNode	withDescription(java.lang.String description)
ComponentNode	withDescriptor(java.util.Collection<Descriptor> __values)
ComponentNode	withDescriptor(Descriptor... __values) Allowed components
ComponentNode	withField(java.util.Collection<Field> __values)
ComponentNode	withField(Field... __values) Sub-fields
ComponentNode	withIsHidden(boolean isHidden)
ComponentNode	withIsHidden(java.lang.Boolean isHidden)
ComponentNode	withIsMandatory(boolean isMandatory)
ComponentNode	withIsMandatory(java.lang.Boolean isMandatory)
ComponentNode	withName(java.lang.String name)
ComponentNode	withNode(java.util.Collection<Node> __values)
ComponentNode	withNode(Node... __values) Sub-nodes
ComponentNode	withOrdering(int ordering)
ComponentNode	withOrdering(java.lang.Integer ordering)
ComponentNode	withTitle(java.lang.String title)
void	writeTo(java.io.OutputStream os) Write this ComponentNode as an XML fragment

Methods inherited from class com.exalead.mercury.component.config.descriptor.Node

getDefaultFieldValue, getDefaultNodeValue, getField, getNode, setDefaultFieldValue, setDefaultNodeValue, withDefaultFieldValue, withDefaultNodeValue

Methods inherited from class com.exalead.mercury.component.config.descriptor.Item

getDescription, getName, getOrdering, getTitle, isIsHidden, isIsMandatory, setDescription, setIsHidden, setIsMandatory, setName, setOrdering, setTitle

Methods inherited from class java.lang.Object

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

Field Detail

descriptor

public java.util.List<Descriptor> descriptor

componentConfigClassId

public java.lang.String componentConfigClassId

Constructor Detail

ComponentNode

public ComponentNode()

ComponentNode

public ComponentNode(ComponentNode o)

Copy constructor

Method Detail

withField

public ComponentNode withField(Field... __values)

Sub-fields

Overrides:

withField in class Node

withField

public ComponentNode withField(java.util.Collection<Field> __values)

Overrides:

withField in class Node

withNode

public ComponentNode withNode(Node... __values)

Sub-nodes

Overrides:

withNode in class Node

withNode

public ComponentNode withNode(java.util.Collection<Node> __values)

Overrides:

withNode in class Node

withDefaultFieldValue

public ComponentNode withDefaultFieldValue(Field... __values)

Field default values

Overrides:

withDefaultFieldValue in class Node

withDefaultFieldValue

public ComponentNode withDefaultFieldValue(java.util.Collection<Field> __values)

Overrides:

withDefaultFieldValue in class Node

withDefaultNodeValue

public ComponentNode withDefaultNodeValue(Node... __values)

Node default values (recursive)

Overrides:

withDefaultNodeValue in class Node

withDefaultNodeValue

public ComponentNode withDefaultNodeValue(java.util.Collection<Node> __values)

Overrides:

withDefaultNodeValue in class Node

withName

public ComponentNode withName(java.lang.String name)

Overrides:

withName in class Node

withTitle

public ComponentNode withTitle(java.lang.String title)

Overrides:

withTitle in class Node

withDescription

public ComponentNode withDescription(java.lang.String description)

Overrides:

withDescription in class Node

withIsMandatory

public ComponentNode withIsMandatory(boolean isMandatory)

Overrides:

withIsMandatory in class Node

withIsMandatory

public ComponentNode withIsMandatory(java.lang.Boolean isMandatory)

Overrides:

withIsMandatory in class Node

withIsHidden

public ComponentNode withIsHidden(boolean isHidden)

Overrides:

withIsHidden in class Node

withIsHidden

public ComponentNode withIsHidden(java.lang.Boolean isHidden)

Overrides:

withIsHidden in class Node

withOrdering

public ComponentNode withOrdering(int ordering)

Overrides:

withOrdering in class Node

withOrdering

public ComponentNode withOrdering(java.lang.Integer ordering)

Overrides:

withOrdering in class Node

getDescriptor

public java.util.List<Descriptor> getDescriptor()

Allowed components

withDescriptor

public ComponentNode withDescriptor(Descriptor... __values)

Allowed components

withDescriptor

public ComponentNode withDescriptor(java.util.Collection<Descriptor> __values)

setComponentConfigClassId

public void setComponentConfigClassId(java.lang.String componentConfigClassId)

Base Class/Interface id of the associated descriptors

getComponentConfigClassId

public java.lang.String getComponentConfigClassId()

Base Class/Interface id of the associated descriptors

withComponentConfigClassId

public ComponentNode withComponentConfigClassId(java.lang.String componentConfigClassId)

makeCopy

public ComponentNode makeCopy()

Creates and returns a deep copy of this ComponentNode.

Overrides:

makeCopy in class Node

readFrom

public static ComponentNode readFrom(java.io.InputStream is)
                              throws javax.xml.bind.JAXBException

Read this ComponentNode from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this ComponentNode as an XML fragment

Overrides:

writeTo in class Node

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static ComponentNode fromString(java.lang.String s)
                                throws javax.xml.bind.JAXBException,
                                       java.io.UnsupportedEncodingException

String representation of this ComponentNode.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ComponentNode.

Overrides:

toString in class Node

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this ComponentNode.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class Node

Throws:

com.exalead.util.TypedException