StructureElementBase (jibx-bind - JiBX binding 1.3.1 API)

java.lang.Object
- org.jibx.binding.model.ElementBase
- - org.jibx.binding.model.NestingElementBase
  - - org.jibx.binding.model.ContainerElementBase
    - - org.jibx.binding.model.StructureElementBase

All Implemented Interfaces:

IComponent

Direct Known Subclasses:

CollectionElement, StructureElement
```
public abstract class StructureElementBase
extends ContainerElementBase
implements IComponent
```
Model component for elements that define the binding structure for an object property. This is the base class for structure and collection elements.

Author:

Dennis M. Sosnoski

Property Summary

All Methods Instance Methods Concrete Methods
Type Property and Description

boolean has
Check if property is defined.

All Methods Instance Methods Concrete Methods
Type	Property and Description
`boolean`	`has` Check if property is defined.

Field Summary

Fields
Modifier and Type Field and Description

static StringArray s_allowedAttributes
Enumeration of allowed attribute names
- Fields inherited from class org.jibx.binding.model.ElementBase
  BINDING_ELEMENT, COLLECTION_ELEMENT, ELEMENT_NAMES, FORMAT_ELEMENT, INCLUDE_ELEMENT, INPUT_ELEMENT, MAPPING_ELEMENT, NAMESPACE_ELEMENT, OUTPUT_ELEMENT, SPLIT_ELEMENT, STRUCTURE_ELEMENT, TEMPLATE_ELEMENT, VALUE_ELEMENT

Fields
Modifier and Type	Field and Description
`static StringArray`	`s_allowedAttributes` Enumeration of allowed attribute names

Constructor Summary

Constructors
Modifier Constructor and Description

protected StructureElementBase(int type)
Constructor.

Constructors
Modifier	Constructor and Description
`protected`	`StructureElementBase(int type)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDeclaredType()` Get declared type name.
`IClassItem`	`getField()` Get field information.
`String`	`getFieldName()` Get field name.
`IClassItem`	`getFlag()` Get flag method information.
`IClassItem`	`getGet()` Get get method information.
`String`	`getGetName()` Get get method name.
`IClass`	`getGetType()` Get type for value loaded to stack.
`String`	`getName()` Get name.
`NamespaceElement`	`getNamespace()` Get effective namespace information.
`IClass`	`getObjectType()` Get class linked to binding element.
`String`	`getPrefix()` Get specified namespace prefix.
`IClassItem`	`getSet()` Get set method information.
`String`	`getSetName()` Get set method name.
`IClass`	`getSetType()` Get type for value stored from stack.
`IClassItem`	`getTest()` Get test method information.
`String`	`getTestName()` Get test method name.
`IClass`	`getType()` Get value type information.
`String`	`getUri()` Get specified namespace URI.
`int`	`getUsage()` Get usage value.
`String`	`getUsageName()` Get usage name.
`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`	`hasName()` Check if component has a name.
`boolean`	`hasObject()` Check if this container defines a context object.
`boolean`	`hasProperty()` Check if property is defined.
`boolean`	`isFlagOnly()` Check if property is flag only.
`boolean`	`isImplicit()` Check if this value implicitly uses the containing object.
`boolean`	`isOptional()` Check if component is an optional item.
`void`	`prevalidate(ValidationContext vctx)` Prevalidate element information.
`void`	`setDeclaredType(String type)` Set declared type name.
`void`	`setFieldName(String field)` Set field name.
`void`	`setFlagName(String flag)` Set flag method name.
`void`	`setGetName(String get)` Set get method name.
`void`	`setName(String name)` Set name.
`void`	`setPrefix(String prefix)` Set namespace prefix.
`void`	`setSetName(String set)` Set set method name.
`void`	`setTestName(String test)` Set test method name.
`void`	`setUri(String uri)` Set namespace URI.
`void`	`setUsage(int use)` Set usage value.
`void`	`setUsageName(String name)` Set usage name.
`void`	`validate(ValidationContext vctx)` Validate element information.

Methods inherited from class org.jibx.binding.model.NestingElementBase
addChild, childIterator, children, getDefaultStyle, getDefinitions, getStyle, getStyleName, setStyleName

Methods inherited from class org.jibx.binding.model.ElementBase
getComment, name, setComment, toString, type, validateAttributes

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Property Detail
  - has
```
public boolean hasProperty
```
    Check if property is defined. This method is only meaningful after a call to prevalidate(ValidationContext).
- Field Detail
  - s_allowedAttributes
```
public static final StringArray s_allowedAttributes
```
    Enumeration of allowed attribute names
- Constructor Detail
  - StructureElementBase
```
protected StructureElementBase(int type)
```
    Constructor.
    
    Parameters:
    
    type - element type code
- Method Detail
  - getName
```
public String getName()
```
    Get name.
    
    Specified by:
    
    getName in interface IComponent
    
    Returns:
    
    name text
  - setName
```
public void setName(String name)
```
    Set name.
    
    Parameters:
    
    name - text for name
  - getUri
```
public String getUri()
```
    Get specified namespace URI.
    
    Specified by:
    
    getUri in interface IComponent
    
    Returns:
    
    namespace URI (null if not set)
  - setUri
```
public void setUri(String uri)
```
    Set namespace URI.
    
    Parameters:
    
    uri - namespace URI (null if not set)
  - getPrefix
```
public String getPrefix()
```
    Get specified namespace prefix.
    
    Returns:
    
    namespace prefix (null if not set)
  - setPrefix
```
public void setPrefix(String prefix)
```
    Set namespace prefix.
    
    Parameters:
    
    prefix - namespace prefix (null if not set)
  - getNamespace
```
public NamespaceElement getNamespace()
```
    Get effective namespace information. This call is only meaningful after validation.
    
    Returns:
    
    effective namespace information
  - getUsageName
```
public String getUsageName()
```
    Get usage name.
    
    Returns:
    
    usage name
  - getUsage
```
public int getUsage()
```
    Get usage value. This call is only meaningful after a call to prevalidate(ValidationContext).
    
    Returns:
    
    usage value
  - setUsageName
```
public void setUsageName(String name)
```
    Set usage name.
    
    Parameters:
    
    name - usage name
  - setUsage
```
public void setUsage(int use)
```
    Set usage value.
    
    Parameters:
    
    use - value
  - hasProperty
```
public boolean hasProperty()
```
    Check if property is defined. This method is only meaningful after a call to prevalidate(ValidationContext).
  - isFlagOnly
```
public boolean isFlagOnly()
```
    Check if property is flag only. This method is only meaningful after a call to prevalidate(ValidationContext).
    
    Returns:
    
    true if flag property, false if not
  - getDeclaredType
```
public String getDeclaredType()
```
    Get declared type name.
    
    Returns:
    
    type name (or null if none)
  - setDeclaredType
```
public void setDeclaredType(String type)
```
    Set declared type name.
    
    Parameters:
    
    type - name (or null if none)
  - getFieldName
```
public String getFieldName()
```
    Get field name.
    
    Returns:
    
    field name (or null if none)
  - getField
```
public IClassItem getField()
```
    Get field information. This call is only meaningful after a call to prevalidate(ValidationContext).
    
    Returns:
    
    field information (or null if none)
  - setFieldName
```
public void setFieldName(String field)
```
    Set field name.
    
    Parameters:
    
    field - field name (or null if none)
  - getTestName
```
public String getTestName()
```
    Get test method name.
    
    Returns:
    
    test method name (or null if none)
  - getTest
```
public IClassItem getTest()
```
    Get test method information. This call is only meaningful after a call to prevalidate(ValidationContext).
    
    Returns:
    
    test method information (or null if none)
  - setTestName
```
public void setTestName(String test)
```
    Set test method name.
    
    Parameters:
    
    test - test method name (or null if none)
  - getFlag
```
public IClassItem getFlag()
```
    Get flag method information. This call is only meaningful after a call to prevalidate(ValidationContext).
    
    Returns:
    
    flag method information (or null if none)
  - setFlagName
```
public void setFlagName(String flag)
```
    Set flag method name.
    
    Parameters:
    
    flag - flag method name (or null if none)
  - getGetName
```
public String getGetName()
```
    Get get method name.
    
    Returns:
    
    get method name (or null if none)
  - getGet
```
public IClassItem getGet()
```
    Get get method information. This call is only meaningful after a call to prevalidate(ValidationContext).
    
    Returns:
    
    get method information (or null if none)
  - getGetType
```
public IClass getGetType()
```
    Get type for value loaded to stack. This call is only meaningful after a call to prevalidate(ValidationContext).
    
    Returns:
    
    get value type (or null if none)
  - setGetName
```
public void setGetName(String get)
```
    Set get method name.
    
    Parameters:
    
    get - get method name (or null if none)
  - getSetName
```
public String getSetName()
```
    Get set method name.
    
    Returns:
    
    set method name (or null if none)
  - getSet
```
public IClassItem getSet()
```
    Get set method information. This call is only meaningful after a call to prevalidate(ValidationContext).
    
    Returns:
    
    set method information (or null if none)
  - getSetType
```
public IClass getSetType()
```
    Get type for value stored from stack. This call is only meaningful after a call to prevalidate(ValidationContext).
    
    Returns:
    
    set value type (or null if none)
  - setSetName
```
public void setSetName(String set)
```
    Set set method name.
    
    Parameters:
    
    set - set method name (or null if none)
  - isImplicit
```
public boolean isImplicit()
```
    Check if this value implicitly uses the containing object. This call is only meaningful after a call to prevalidate(ValidationContext).
    
    Specified by:
    
    isImplicit in interface IComponent
    
    Returns:
    
    true if using the containing object, false if own value
  - isOptional
```
public boolean isOptional()
```
    Description copied from interface: IComponent
    
    Check if component is an optional item.
    
    Specified by:
    
    isOptional in interface IComponent
    
    Returns:
    
    true if optional, false if required
  - hasObject
```
public boolean hasObject()
```
    Description copied from class: ContainerElementBase
    
    Check if this container defines a context object.
    
    Specified by:
    
    hasObject in class ContainerElementBase
    
    Returns:
    
    true if defines context object, false if not
  - hasAttribute
```
public boolean hasAttribute()
```
    Description copied from interface: IComponent
    
    Check if component defines one or more attribute values of the containing element. This method is only valid after validation.
    
    Specified by:
    
    hasAttribute in interface IComponent
    
    Returns:
    
    true if one or more attribute values defined for containing element, false if not
  - 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 validation.
    
    Specified by:
    
    hasContent in interface IComponent
    
    Returns:
    
    true if one or more content values defined for containing element, false if not
  - hasName
```
public boolean hasName()
```
    Description copied from interface: IComponent
    
    Check if component has a name.
    
    Specified by:
    
    hasName in interface IComponent
    
    Returns:
    
    true if component has a name, false if not
  - getType
```
public IClass getType()
```
    Description copied from interface: IComponent
    
    Get value type information. This call is only meaningful after prevalidation.
    
    Specified by:
    
    getType in interface IComponent
    
    Returns:
    
    type information
  - getObjectType
```
public IClass getObjectType()
```
    Description copied from class: ContainerElementBase
    
    Get class linked to binding element. This call is only meaningful after validation.
    
    Specified by:
    
    getObjectType in class ContainerElementBase
    
    Returns:
    
    information for class linked by binding
  - prevalidate
```
public void prevalidate(ValidationContext vctx)
```
    Description copied from class: ElementBase
    
    Prevalidate element information. The prevalidation step is used to check isolated aspects of an element, such as the settings for enumerated values on the element and attributes. This empty base class implementation should be overridden by each subclass that requires prevalidation handling.
    
    Overrides:
    
    prevalidate in class ContainerElementBase
    
    Parameters:
    
    vctx - validation context
  - validate
```
public void validate(ValidationContext vctx)
```
    Description copied from class: ElementBase
    
    Validate element information. The validation step is used for checking the interactions between elements, such as name references to other elements. The ElementBase.prevalidate(org.jibx.binding.model.ValidationContext) method will always be called for every element in the binding definition before this method is called for any element. This empty base class implementation should be overridden by each subclass that requires validation handling.
    
    Overrides:
    
    validate in class ContainerElementBase
    
    Parameters:
    
    vctx - validation context

Class StructureElementBase

Property Summary

Field Summary

Fields inherited from class org.jibx.binding.model.ElementBase

Constructor Summary

Method Summary

Methods inherited from class org.jibx.binding.model.ContainerElementBase

Methods inherited from class org.jibx.binding.model.NestingElementBase

Methods inherited from class org.jibx.binding.model.ElementBase

Methods inherited from class java.lang.Object

Property Detail

has

Field Detail

s_allowedAttributes

Constructor Detail

StructureElementBase

Method Detail

getName

setName

getUri

setUri

getPrefix

setPrefix

getNamespace

getUsageName

getUsage

setUsageName

setUsage

hasProperty

isFlagOnly

getDeclaredType

setDeclaredType

getFieldName

getField

setFieldName

getTestName

getTest

setTestName

getFlag

setFlagName

getGetName

getGet

getGetType

setGetName

getSetName

getSet

getSetType

setSetName

isImplicit

isOptional

hasObject

hasAttribute

hasContent

hasName

getType

getObjectType

prevalidate

validate