org.jibx.schema.codegen

Class ClassHolder.ParentNode

java.lang.Object

org.jibx.schema.codegen.ClassHolder.DataNode

org.jibx.schema.codegen.ClassHolder.ParentNode

Enclosing class:

ClassHolder

protected static class ClassHolder.ParentNode
extends ClassHolder.DataNode

Information for an interior node of the data structure tree. Depending on the type of the associated schema component a selector field may be used to track which of a set of alternatives is actually present.

Constructor Summary

Constructors

Constructor and Description
ClassHolder.ParentNode(GroupItem group, ClassHolder.ParentNode parent) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addChild(ClassHolder.DataNode value) Add a child node (which may be another parent) to this parent.
void	adjustName() Adjust name based on group nesting.
String	describe(int depth) Generate the subtree description.
ArrayList	getChildren() Get child nodes of this parent.
String	getPrefix() Get prefix for value names in group.
String	getSelectCheckMethod() Get selector check method name.
String	getSelectField() Get selector field name.
int	getSelectorType() Get the selector type.
String	getSelectSetMethod() Get selector set method name.
boolean	isComplexCollection() Check if this is a collection that wraps some other structure (rather than a simple leaf node).
boolean	isInterior() Check if this is an interior node (always true).
boolean	isSelectorExposed() Check if selector state should be exposed to user.
boolean	isSelectorNeeded() Check if a selector field is required for this group.
boolean	isSelectorType() Check if a selector field may be required for this group.
void	setSelectCheckMethod(String name) Set selector check method name.
void	setSelectField(String name) Set selector field name.
void	setSelectSetMethod(String name) Set selector set method name.

Methods inherited from class org.jibx.schema.codegen.ClassHolder.DataNode

appendDocText, appendSelectConstText, getBindingType, getDocumentation, getFieldName, getFlagMethodName, getGetMethodName, getItem, getParent, getPropName, getQName, getReferenceQName, getSchemaComponent, getSelectConstName, getSelectPropName, getSetMethodName, getTestMethodName, getType, isAny, isCollection, isIgnored, isList, isNamed, isOptional, isReference, setDocumentation, setFieldName, setFlagMethodName, setGetMethodName, setPropName, setSelectConstName, setSelectPropName, setSetMethodName, setTestMethodName

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassHolder.ParentNode

public ClassHolder.ParentNode(GroupItem group,
                      ClassHolder.ParentNode parent)

Constructor. This derives the prefix used for all contained value names by appending the class name set for this group to the prefix used for the containing group.

Parameters:

group - associated item group

parent - containing node

Method Detail

isInterior

public boolean isInterior()

Check if this is an interior node (always true).

Specified by:

isInterior in class ClassHolder.DataNode

Returns:

true for structure component

isSelectorNeeded

public boolean isSelectorNeeded()

Check if a selector field is required for this group.

Returns:

selector

isSelectorType

public boolean isSelectorType()

Check if a selector field may be required for this group.

Returns:

selector

getSelectorType

public int getSelectorType()

Get the selector type.

Returns:

type

isSelectorExposed

public boolean isSelectorExposed()

Check if selector state should be exposed to user.

Returns:

selector

adjustName

public void adjustName()

Adjust name based on group nesting. This has special handling for the case of <sequence> compositors, substituting the name of the first value in the sequence for the value name if a fixed name has not been assigned to the sequence.

getPrefix

public String getPrefix()

Get prefix for value names in group.

Returns:

prefix (null if none used)

addChild

protected void addChild(ClassHolder.DataNode value)

Add a child node (which may be another parent) to this parent. This method is normally only used by the superclass, when creating a new instance. The instance must be fully initialized before it is added.

Parameters:

value -

getChildren

public ArrayList getChildren()

Get child nodes of this parent. The returned list is "live", but should never be modified.

Returns:

values

isComplexCollection

public boolean isComplexCollection()

Check if this is a collection that wraps some other structure (rather than a simple leaf node).

Returns:

true if wrapper collection

getSelectField

public String getSelectField()

Get selector field name.

Returns:

name (null if no selector for group)

setSelectField

public void setSelectField(String name)

Set selector field name.

Parameters:

name - (null if no selector for group)

getSelectSetMethod

public String getSelectSetMethod()

Get selector set method name.

Returns:

name (null if no selector set method for group)

setSelectSetMethod

public void setSelectSetMethod(String name)

Set selector set method name.

Parameters:

name - (null if no selector set method for group)

getSelectCheckMethod

public String getSelectCheckMethod()

Get selector check method name.

Returns:

name (null if no selector check method for group)

setSelectCheckMethod

public void setSelectCheckMethod(String name)

Set selector check method name.

Parameters:

name - (null if no selector check method for group)

describe

public String describe(int depth)

Generate the subtree description.

Specified by:

describe in class ClassHolder.DataNode

Parameters:

depth - current nesting depth

Returns:

description