org.jibx.binding.def
Class NestedStructure

java.lang.Object
  extended byorg.jibx.binding.def.BindingBuilder.ContainerBase
      extended byorg.jibx.binding.def.NestedBase
          extended byorg.jibx.binding.def.NestedStructure
All Implemented Interfaces:
IComponent, IContainer

public class NestedStructure
extends NestedBase

Structure binding definition. This handles one or more child components, which may be ordered or unordered.

Version:
1.0
Author:
Dennis M. Sosnoski

Field Summary
private static java.lang.String CHECK_ISSTART_NAME
           
private static java.lang.String CHECK_ISSTART_SIGNATURE
           
private  boolean m_allowDuplicates
          Flag for duplicate values allowed when unmarshalling unordered group.
private  boolean m_hasObject
          Flag for structure has associated object.
private  IComponent m_idChild
          Child supplying ID for bound class.
protected  boolean m_isChoice
          Flag for choice of child content (used by subclasses).
private  boolean m_isLinked
          Flag for already linked (to avoid multiple passes).
private static java.lang.String SKIP_ELEMENT_NAME
           
private static java.lang.String SKIP_ELEMENT_SIGNATURE
           
private static java.lang.String THROW_EXCEPTION_NAME
           
private static java.lang.String THROW_EXCEPTION_SIGNATURE
           
 
Fields inherited from class org.jibx.binding.def.NestedBase
m_accessLevel, m_attributes, m_autoLink, m_container, m_contents, m_isFlexible, m_isOrdered, m_nameStyle, m_stripPrefix, m_stripSuffix, m_styleDefault
 
Constructor Summary
NestedStructure(IContainer parent, IContextObj objc, boolean ord, boolean choice, boolean flex, boolean ctx, boolean hasobj, boolean dupl)
          Constructor.
 
Method Summary
 void genAttributeMarshal(ContextMethodBuilder mb)
          Generate attribute marshalling code.
 void genAttributeUnmarshal(ContextMethodBuilder mb)
          Generate attribute unmarshalling code.
 void genAttrPresentTest(ContextMethodBuilder mb)
          Generate code to test for attribute present.
 void genContentMarshal(ContextMethodBuilder mb)
          Generate element or text marshalling code.
 void genContentUnmarshal(ContextMethodBuilder mb)
          Generate element or text unmarshalling code.
private  void genFlagTest(boolean cond, int pos, java.lang.String msg, NameDefinition name, ContextMethodBuilder mb)
          Helper method to generate test code for value in boolean array.
 void genLoadId(ContextMethodBuilder mb)
          Generate code to load ID value of instance to stack.
 java.lang.String getType()
          Get type expected by component.
 boolean hasAttribute()
          Check if component defines one or more attribute values of the containing element.
 boolean hasContent()
          Check if component defines one or more elements or text values as children of the containing element.
 boolean hasId()
          Check if component defines an ID value for instances of context object.
 void print(int depth)
           
 void setLinkages()
          Establish and validate linkages between binding components.
 void setObjectContext(IContextObj objc)
          Set the object context.
 
Methods inherited from class org.jibx.binding.def.NestedBase
addComponent, genContentPresentTest, genNewInstance, getAttributes, getBindingRoot, getContents, getDefinitionContext, getStyleDefault, getWrapperName, hasNamespaces, isContentOrdered, isFlexible, isOptional, unmarshal
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.jibx.binding.def.IContainer
getStyleDefault
 

Field Detail

CHECK_ISSTART_NAME

private static final java.lang.String CHECK_ISSTART_NAME
See Also:
Constant Field Values

CHECK_ISSTART_SIGNATURE

private static final java.lang.String CHECK_ISSTART_SIGNATURE
See Also:
Constant Field Values

SKIP_ELEMENT_NAME

private static final java.lang.String SKIP_ELEMENT_NAME
See Also:
Constant Field Values

SKIP_ELEMENT_SIGNATURE

private static final java.lang.String SKIP_ELEMENT_SIGNATURE
See Also:
Constant Field Values

THROW_EXCEPTION_NAME

private static final java.lang.String THROW_EXCEPTION_NAME
See Also:
Constant Field Values

THROW_EXCEPTION_SIGNATURE

private static final java.lang.String THROW_EXCEPTION_SIGNATURE
See Also:
Constant Field Values

m_idChild

private IComponent m_idChild
Child supplying ID for bound class.


m_isChoice

protected final boolean m_isChoice
Flag for choice of child content (used by subclasses).


m_allowDuplicates

private final boolean m_allowDuplicates
Flag for duplicate values allowed when unmarshalling unordered group.


m_hasObject

private boolean m_hasObject
Flag for structure has associated object.


m_isLinked

private boolean m_isLinked
Flag for already linked (to avoid multiple passes).

Constructor Detail

NestedStructure

public NestedStructure(IContainer parent,
                       IContextObj objc,
                       boolean ord,
                       boolean choice,
                       boolean flex,
                       boolean ctx,
                       boolean hasobj,
                       boolean dupl)
Constructor.

Parameters:
parent - containing binding definition context
objc - current object context
ord - ordered content flag
choice - choice content flag
flex - flexible element handling flag
ctx - define context for structure flag
hasobj - has associated object flag
dupl - allow duplicates in unordered group flag
Method Detail

setObjectContext

public void setObjectContext(IContextObj objc)
Set the object context.

Overrides:
setObjectContext in class NestedBase
Parameters:
objc - object context

hasAttribute

public boolean hasAttribute()
Description copied from interface: IComponent
Check if component defines one or more attribute values of the containing element.

Returns:
true if one or more attribute values defined for containing element, false if not

genAttrPresentTest

public void genAttrPresentTest(ContextMethodBuilder mb)
                        throws JiBXException
Description copied from interface: IComponent
Generate code to test for attribute present. This generates code that tests if a child is present as determined by attributes of the containing start tag. It leaves the result of the test (zero if missing, nonzero if present) on the stack. This call is only valid if this component has one or more attributes for the containing element.

Parameters:
mb - method builder
Throws:
JiBXException - if configuration error

genAttributeUnmarshal

public void genAttributeUnmarshal(ContextMethodBuilder mb)
                           throws JiBXException
Description copied from interface: IComponent
Generate attribute unmarshalling code. This is called within the code generation for the unmarshaller of the class associated with the containing element. It needs to generate the necessary code for handling the unmarshalling operation, leaving the unmarshalled object reference on the stack.

Parameters:
mb - method builder
Throws:
JiBXException - if error in configuration

genAttributeMarshal

public void genAttributeMarshal(ContextMethodBuilder mb)
                         throws JiBXException
Description copied from interface: IComponent
Generate attribute marshalling code. This is called within the code generation for the marshaller of the class associated with the containing element. It needs to generate the necessary code for handling the marshalling operation, consuming the marshalled object reference from the stack.

Parameters:
mb - method builder
Throws:
JiBXException - if error in configuration

hasContent

public boolean hasContent()
Description copied from interface: IComponent
Check if component defines one or more elements or text values as children of the containing element. This method is only valid after the call to IComponent.setLinkages().

Specified by:
hasContent in interface IComponent
Overrides:
hasContent in class NestedBase

genContentUnmarshal

public void genContentUnmarshal(ContextMethodBuilder mb)
                         throws JiBXException
Description copied from interface: IComponent
Generate element or text unmarshalling code. This is called within the code generation for the unmarshaller of the class associated with the containing element. It needs to generate the necessary code for handling the unmarshalling operation, leaving the unmarshalled object reference on the stack.

Parameters:
mb - method builder
Throws:
JiBXException - if error in configuration

genFlagTest

private void genFlagTest(boolean cond,
                         int pos,
                         java.lang.String msg,
                         NameDefinition name,
                         ContextMethodBuilder mb)
Helper method to generate test code for value in boolean array. If the test fails, the generated code throws an exception with the appropriate error message.

Parameters:
cond - flag setting resulting in exception
pos - position of element in list of child components
msg - basic error message when test fails
name -
mb -

genContentMarshal

public void genContentMarshal(ContextMethodBuilder mb)
                       throws JiBXException
Description copied from interface: IComponent
Generate element or text marshalling code. This is called within the code generation for the marshaller of the class associated with the containing element. It needs to generate the necessary code for handling the marshalling operation, consuming the marshalled object reference from the stack.

Parameters:
mb - method builder
Throws:
JiBXException - if error in configuration

getType

public java.lang.String getType()
Description copied from interface: IComponent
Get type expected by component.

Specified by:
getType in interface IComponent
Overrides:
getType in class NestedBase

hasId

public boolean hasId()
Description copied from interface: IComponent
Check if component defines an ID value for instances of context object.

Returns:
true if ID value defined for instances, false if not

genLoadId

public void genLoadId(ContextMethodBuilder mb)
               throws JiBXException
Description copied from interface: IComponent
Generate code to load ID value of instance to stack. The generated code should assume that the top of the stack is the reference for the containing object. It must consume this and leave the actual ID value on the stack (as a String).

Parameters:
mb - method builder
Throws:
JiBXException - if configuration error

setLinkages

public void setLinkages()
                 throws JiBXException
Description copied from interface: IComponent
Establish and validate linkages between binding components. This is called after the basic binding structures have been set up. All linkages between components must be resolved by this method, in order to prevent problems due to the order of definitions between components. This implies that each component must in turn call the same method for each child component. None of the other method calls defined by this interface are valid until after this call.

Throws:
JiBXException - if error in configuration

print

public void print(int depth)


Project Web Site