org.jibx.schema.codegen

Class Item

java.lang.Object

org.jibx.schema.codegen.Item

Direct Known Subclasses:

AnyItem, GroupItem, ReferenceItem, ValueItem

public abstract class Item
extends Object

Base class for code generation items. Each instance corresponds to a particular schema component, and this base class tracks that schema component (by way of the extension information), along with related details and linkage information. The linkage uses embedded list links, which allows replacing one instance with another with minimal overhead.

Author:

Dennis M. Sosnoski

Field Summary

Fields

Modifier and Type	Field and Description
protected Item	m_last Preceding item in list (null if none).
protected Item	m_next Next item in list (null if none).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Item(AnnotatedBase comp, GroupItem parent) Basic constructor.
protected	Item(Item original, Item ref, ComponentExtension ext, GroupItem parent) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	classifyContent() Classify the content of this item as attribute, element, and/or character data content, and as requiring content of some form if appropriate.
protected abstract Item	copy(Item ref, GroupItem parent) Copy the item under a different parent.
protected abstract String	describe(int depth, boolean classified) Generate a description of the item.
protected GroupItem	findDisjointParent() Find the nearest ancestor group which relates to a different schema component.
ComponentExtension	getComponentExtension() Get schema component annotation corresponding to this item.
String	getEffectiveName() Get effective item name, applying inheritance if necessary.
String	getName() Get name set directly for this item.
Item	getNext() Get next item in list.
GroupItem	getParent() Get containing group item.
AnnotatedBase	getSchemaComponent() Get schema component corresponding to this item.
Item	getTopmost() Get the topmost item associated with the same schema component as this item.
boolean	isCollection() Check if a collection item.
boolean	isFixedName() Check if the name is fixed by configuration.
boolean	isIgnored() Check if item is ignored.
boolean	isImplicit() Check if the item is represented implicitly by subclassing.
boolean	isOptional() Check if item is optional.
boolean	isTopmost() Check if topmost item for a particular schema component.
protected String	leadString(int depth) Generate the standard leading text for description of the item.
protected void	reparent(GroupItem parent) Replace the parent for this item.
void	setImplicit(boolean implicit) Set item represented implicitly by subclassing flag.
void	setName(String name) Set name directly for this item.

Methods inherited from class java.lang.Object

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

Field Detail

m_next

protected Item m_next

Next item in list (null if none).

m_last

protected Item m_last

Preceding item in list (null if none).

Constructor Detail

Item

protected Item(AnnotatedBase comp,
    GroupItem parent)

Basic constructor. This uses the schema component to determine all information other than the parent item group, including the optional/nillable/collection flags. As a special case, if the parent group is associated with the same component this sets all three of these flags false to avoid redundant handling.

Parameters:

comp - schema component

parent - containing group (null if a top-level group)

Item

protected Item(Item original,
    Item ref,
    ComponentExtension ext,
    GroupItem parent)

Copy constructor. This creates a copy with a new parent.

Parameters:

original -

ref - reference (for name override; null if none)

ext - component extension to be linked with copy

parent - (non-null)

Method Detail

reparent

protected void reparent(GroupItem parent)

Replace the parent for this item.

Parameters:

parent -

getSchemaComponent

public AnnotatedBase getSchemaComponent()

Get schema component corresponding to this item.

Returns:

schema component

getComponentExtension

public ComponentExtension getComponentExtension()

Get schema component annotation corresponding to this item.

Returns:

schema component

getParent

public GroupItem getParent()

Get containing group item.

Returns:

group (null if a top-level group)

isFixedName

public boolean isFixedName()

Check if the name is fixed by configuration.

Returns:

true if fixed, false if not

getEffectiveName

public String getEffectiveName()

Get effective item name, applying inheritance if necessary.

Returns:

name

getName

public String getName()

Get name set directly for this item.

Returns:

name (null if to be inherited)

setName

public void setName(String name)

Set name directly for this item. It is an error to call this method if the name is fixed.

Parameters:

name - (null if to be inherited)

getNext

public Item getNext()

Get next item in list.

Returns:

next

isTopmost

public boolean isTopmost()

Check if topmost item for a particular schema component. The methods isCollection(), isOptional(), GroupItem.isAllOptional(), GroupItem.isAttributePresent(), GroupItem.isContentPresent(), and GroupItem.isElementPresent() are all only meaningful for the topmost item associated with a schema component.

Returns:

topmost

getTopmost

public Item getTopmost()

Get the topmost item associated with the same schema component as this item. The methods isCollection(), isOptional(), GroupItem.isAllOptional(), GroupItem.isAttributePresent(), GroupItem.isContentPresent(), and GroupItem.isElementPresent() are all only meaningful for the topmost item associated with a schema component.

Returns:

topmost

isOptional

public boolean isOptional()

Check if item is optional. This method is only meaningful for the topmost item associated with a particular schema component (those for which isTopmost() returns true).

Returns:

optional

isIgnored

public boolean isIgnored()

Check if item is ignored. This method is only meaningful for the topmost item associated with a particular schema component (those for which isTopmost() returns true).

Returns:

optional

isCollection

public boolean isCollection()

Check if a collection item. This method is only meaningful for the topmost item associated with a particular schema component (those for which isTopmost() returns true).

Returns:

true if collection

isImplicit

public boolean isImplicit()

Check if the item is represented implicitly by subclassing.

Returns:

implicit

setImplicit

public void setImplicit(boolean implicit)

Set item represented implicitly by subclassing flag.

Parameters:

implicit -

copy

protected abstract Item copy(Item ref,
        GroupItem parent)

Copy the item under a different parent. This is intended for replacing a reference with a copy, and allows the reference to override settings from the original.

Parameters:

ref - reference (for overrides to copy; null if none)

parent -

Returns:

copy

findDisjointParent

protected GroupItem findDisjointParent()

Find the nearest ancestor group which relates to a different schema component.

Returns:

ancestor with different schema component, or null if none

classifyContent

protected void classifyContent()

Classify the content of this item as attribute, element, and/or character data content, and as requiring content of some form if appropriate. This needs to be done as a separate step after construction in order to handle references, which must assume the content of the definition, and also to work after inlining. This base class implementation does the classification based solely on the schema component type. Any subclasses which override this method should generally call the base class implementation before doing their own classification handling, unless they use a substitute component.

describe

protected abstract String describe(int depth,
              boolean classified)

Generate a description of the item. For items with nested items this will show the complete structure.

Parameters:

depth - current nesting depth

classified - include classification details flag

Returns:

description

leadString

protected String leadString(int depth)

Generate the standard leading text for description of the item.

Parameters:

depth - current nesting depth

Returns:

leading text for description