org.jibx.schema.generator
Class MappingDetail

java.lang.Object
  extended by org.jibx.schema.generator.MappingDetail

public class MappingDetail
extends java.lang.Object

Holder for the details of how a mapping is to be represented in a schema. Each mapping is converted to a complex type, but the complex type may be either global or local to a containing global element. In the case of a mapping used as the base for one or more extension types, both a global complex type and a global element that references the type are required. This also tracks the content form for the complex type definition.

Author:
Dennis M. Sosnoski

Field Summary
private  MappingElement m_extensionBase
          Schema type extension base mapping.
private  boolean m_hasAttribute
          Has attribute(s) flag.
private  boolean m_hasChild
          Has child element(s) flag.
private  boolean m_hasText
          Has child text(s) flag.
private  boolean m_isElement
          Generate as element flag.
private  boolean m_isGroup
          Generate as group/attributeGroup flag.
private  boolean m_isType
          Generate as complex type flag.
private  MappingElementBase m_mapping
          Mapping to be generated.
private  QName m_otherName
          Element/group/attributeGroup name (ignored if not generated as any of these).
private  QName m_substitutionName
          Substitution group base name.
private  QName m_typeName
          Type name (ignored if not generated as complex type).
 
Constructor Summary
MappingDetail(MappingElementBase map, boolean haschild, boolean hastext, MappingElement base, QName tname, QName oname)
          Constructor.
 
Method Summary
 MappingElement getExtensionBase()
          Get base mapping for schema type extension.
 MappingElementBase getMapping()
          Get mapping.
 QName getOtherName()
          Get element name.
 QName getSubstitution()
          Get substitution group base name.
 QName getTypeName()
          Get name for type.
 boolean hasAttribute()
          Check if attribute component present.
 boolean hasChild()
          Check if child element component present.
 boolean hasText()
          Check if text component present.
 boolean isElement()
          Check if generating as an element.
 boolean isGroup()
          Check if generating as a group.
 boolean isType()
          Check if generating as a group.
 void setElement(boolean gen)
          Set generating as an element.
 void setGroup(boolean gen)
          Set generating as a group.
 void setSubstitution(QName qname)
          Set substitution group base name.
 void setType(boolean gen)
          Set generating as a type.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

m_mapping

private final MappingElementBase m_mapping
Mapping to be generated.


m_extensionBase

private final MappingElement m_extensionBase
Schema type extension base mapping.


m_hasChild

private final boolean m_hasChild
Has child element(s) flag.


m_hasText

private final boolean m_hasText
Has child text(s) flag.


m_hasAttribute

private final boolean m_hasAttribute
Has attribute(s) flag.


m_typeName

private final QName m_typeName
Type name (ignored if not generated as complex type).


m_otherName

private final QName m_otherName
Element/group/attributeGroup name (ignored if not generated as any of these).


m_substitutionName

private QName m_substitutionName
Substitution group base name.


m_isType

private boolean m_isType
Generate as complex type flag.


m_isElement

private boolean m_isElement
Generate as element flag.


m_isGroup

private boolean m_isGroup
Generate as group/attributeGroup flag. If set, will be generated as either a group (if elements defined), an attributeGroup (if attributes defined), or both.

Constructor Detail

MappingDetail

public MappingDetail(MappingElementBase map,
                     boolean haschild,
                     boolean hastext,
                     MappingElement base,
                     QName tname,
                     QName oname)
Constructor.

Parameters:
map - mapping definition
haschild - has child element(s) flag
hastext - has child text(s) flag
base - base mapping for schema type extension
tname - name as type
oname - name as element/group/attributeGroup
Method Detail

isElement

public boolean isElement()
Check if generating as an element.

Returns:
flag

setElement

public void setElement(boolean gen)
Set generating as an element.

Parameters:
gen -

isGroup

public boolean isGroup()
Check if generating as a group.

Returns:
flag

setGroup

public void setGroup(boolean gen)
Set generating as a group.

Parameters:
gen -

isType

public boolean isType()
Check if generating as a group.

Returns:
flag

setType

public void setType(boolean gen)
Set generating as a type.

Parameters:
gen -

getExtensionBase

public MappingElement getExtensionBase()
Get base mapping for schema type extension.

Returns:
extension base

hasAttribute

public boolean hasAttribute()
Check if attribute component present.

Returns:
flag

hasChild

public boolean hasChild()
Check if child element component present.

Returns:
flag

hasText

public boolean hasText()
Check if text component present.

Returns:
flag

getMapping

public MappingElementBase getMapping()
Get mapping.

Returns:
mapping

getTypeName

public QName getTypeName()
Get name for type.

Returns:
name

getOtherName

public QName getOtherName()
Get element name.

Returns:
element name for concrete mapping (null if abstract)

getSubstitution

public QName getSubstitution()
Get substitution group base name.

Returns:
substitution group base name

setSubstitution

public void setSubstitution(QName qname)
Set substitution group base name.

Parameters:
qname -


Project Web Site