org.jboss.xb.binding.sunday.unmarshalling
Class TypeBinding

java.lang.Object
  extended by org.jboss.xb.binding.sunday.unmarshalling.TypeBinding
Direct Known Subclasses:
SimpleTypeBinding

public class TypeBinding
extends Object

Version:
$Revision: 2926 $
Author:
Alexey Loubyansky

Field Summary
protected  QName qName
           
 
Constructor Summary
TypeBinding()
           
TypeBinding(CharactersHandler charactersHandler)
           
TypeBinding(QName qName)
           
TypeBinding(QName qName, CharactersHandler charactersHandler)
           
TypeBinding(QName qName, TypeBinding baseType)
           
 
Method Summary
 void addAttribute(AttributeBinding attr)
           
 AttributeBinding addAttribute(QName name, TypeBinding type, AttributeHandler handler)
           
 void addElement(ElementBinding element)
           
 void addElement(ElementBinding element, int minOccurs, boolean unbounded)
           
 ElementBinding addElement(QName name, TypeBinding type)
           
 ElementBinding addElement(QName name, TypeBinding type, int minOccurs, boolean unbounded)
           
 void addEnumValue(String value)
           
 void addGroup(Map<QName,TypeBinding> group)
           
 void addLexicalPattern(String patternValue)
           
 void addParticle(ParticleBinding particle)
           
 Attributes expandWithDefaultAttributes(Attributes attrs)
          Go through the type attributes to see if there are any with defaults that do not appears in the attrs list.
 AddMethodMetaData getAddMethodMetaData()
           
 AnyAttributeBinding getAnyAttribute()
           
 AttributeBinding getAttribute(QName qName)
           
 Collection<AttributeBinding> getAttributes()
           
 TypeBinding getBaseType()
           
 TermBeforeMarshallingCallback getBeforeMarshallingCallback()
           
 TermBeforeSetParentCallback getBeforeSetParentCallback()
           
 CharactersHandler getCharactersHandler()
           
 CharactersMetaData getCharactersMetaData()
           
 ClassMetaData getClassMetaData()
           
 ElementBinding getElement(QName name)
           
 ParticleHandler getHandler()
           
 List<ElementInterceptor> getInterceptors(QName qName)
          Returns a list of local interceptors for the element.
 TypeBinding getItemType()
           
 List<String> getLexicalEnumeration()
           
 List<String> getLexicalPattern()
           
 MapEntryMetaData getMapEntryMetaData()
           
 ParticleBinding getParticle()
           
 PropertyMetaData getPropertyMetaData()
           
 QName getQName()
           
 SchemaBinding getSchemaBinding()
           
 TypeBinding getSimpleType()
           
 ValueAdapter getValueAdapter()
           
 ValueMetaData getValueMetaData()
           
 WildcardBinding getWildcard()
           
 XOPMarshaller getXopMarshaller()
           
 XOPUnmarshaller getXopUnmarshaller()
           
 boolean hasOnlyXmlMimeAttributes()
           
 boolean isIgnoreEmptyString()
           
 boolean isSimple()
           
 boolean isSkip()
           
 boolean isStartElementCreatesObject()
          Whether the ParticleHandler should return a non-null object from its startParticle method.
 boolean isTextContentAllowed()
           
 void pushInterceptor(QName qName, ElementInterceptor interceptor)
          Pushes a new interceptor for the specified element.
 void setAddMethodMetaData(AddMethodMetaData addMethodMetaData)
           
 void setAnyAttribute(AnyAttributeBinding anyAttribute)
           
 void setBaseType(TypeBinding baseType)
           
 void setBeforeMarshallingCallback(TermBeforeMarshallingCallback marshallingHandler)
           
 void setBeforeSetParentCallback(TermBeforeSetParentCallback beforeSetParent)
           
 void setCharactersHandler(CharactersHandler charactersHandler)
           
 void setCharactersMetaData(CharactersMetaData charMetaData)
           
 void setClassMetaData(ClassMetaData classMetaData)
           
 void setHandler(ParticleHandler handler)
           
 void setIgnoreEmptyString(boolean value)
           
 void setItemType(TypeBinding itemType)
           
 void setMapEntryMetaData(MapEntryMetaData mapEntryMetaData)
           
 void setParticle(ParticleBinding particle)
           
 void setPropertyMetaData(PropertyMetaData propertyMetaData)
           
 void setSchemaBinding(SchemaBinding schemaBinding)
           
 void setSimple(boolean simple)
           
 void setSimpleType(CharactersHandler charactersHandler)
          This method will create a new simple type binding with the passed in characters handler and set this simple type as the simple type of the complex type the method was invoked on.
 void setSimpleType(TypeBinding simpleType)
           
 void setSkip(boolean skip)
           
 void setStartElementCreatesObject(boolean startElementCreatesObject)
          Whether the ParticleHandler should return a non-null object from its startParticle method.
 void setValueAdapter(ValueAdapter valueAdapter)
           
 void setValueMetaData(ValueMetaData valueMetaData)
           
 void setXopMarshaller(XOPMarshaller xopMarshaller)
           
 void setXopUnmarshaller(XOPUnmarshaller xopUnmarshaller)
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

qName

protected QName qName
Constructor Detail

TypeBinding

public TypeBinding()

TypeBinding

public TypeBinding(QName qName)

TypeBinding

public TypeBinding(CharactersHandler charactersHandler)

TypeBinding

public TypeBinding(QName qName,
                   CharactersHandler charactersHandler)

TypeBinding

public TypeBinding(QName qName,
                   TypeBinding baseType)
Method Detail

getQName

public QName getQName()

getElement

public ElementBinding getElement(QName name)

addParticle

public void addParticle(ParticleBinding particle)

addElement

public void addElement(ElementBinding element)

addElement

public void addElement(ElementBinding element,
                       int minOccurs,
                       boolean unbounded)

addElement

public ElementBinding addElement(QName name,
                                 TypeBinding type)

addElement

public ElementBinding addElement(QName name,
                                 TypeBinding type,
                                 int minOccurs,
                                 boolean unbounded)

addGroup

public void addGroup(Map<QName,TypeBinding> group)

getAttribute

public AttributeBinding getAttribute(QName qName)

expandWithDefaultAttributes

public Attributes expandWithDefaultAttributes(Attributes attrs)
Go through the type attributes to see if there are any with defaults that do not appears in the attrs list.

Parameters:
attrs - - the attributes seen in the document
Returns:
a possibly augmented list that includes unspecified attributes with default values.

addAttribute

public AttributeBinding addAttribute(QName name,
                                     TypeBinding type,
                                     AttributeHandler handler)

addAttribute

public void addAttribute(AttributeBinding attr)

getAttributes

public Collection<AttributeBinding> getAttributes()

getCharactersHandler

public CharactersHandler getCharactersHandler()

setCharactersHandler

public void setCharactersHandler(CharactersHandler charactersHandler)

setSimpleType

public void setSimpleType(CharactersHandler charactersHandler)
This method will create a new simple type binding with the passed in characters handler and set this simple type as the simple type of the complex type the method was invoked on.

Parameters:
charactersHandler -

getSimpleType

public TypeBinding getSimpleType()

setSimpleType

public void setSimpleType(TypeBinding simpleType)

setHandler

public void setHandler(ParticleHandler handler)

getHandler

public ParticleHandler getHandler()

pushInterceptor

public void pushInterceptor(QName qName,
                            ElementInterceptor interceptor)
Pushes a new interceptor for the specified element. If the element has a global scope in the schema, this interceptor will invoked only when the element is found to be a child of this type. This is the difference between the local interceptors added with this method and the interceptors added directly to the element binding. When element is started, local interceptors are invoked before the interceptors from the element binding. In the endElement the order is reversed.

Parameters:
qName -
interceptor -

getInterceptors

public List<ElementInterceptor> getInterceptors(QName qName)
Returns a list of local interceptors for the element. If there are no local interceptors for the element then an empty list is returned.

Parameters:
qName -
Returns:

getBaseType

public TypeBinding getBaseType()

setBaseType

public void setBaseType(TypeBinding baseType)

isSimple

public boolean isSimple()

setSimple

public void setSimple(boolean simple)

isTextContentAllowed

public boolean isTextContentAllowed()

getClassMetaData

public ClassMetaData getClassMetaData()

setClassMetaData

public void setClassMetaData(ClassMetaData classMetaData)

getSchemaBinding

public SchemaBinding getSchemaBinding()

setSchemaBinding

public void setSchemaBinding(SchemaBinding schemaBinding)

setValueMetaData

public void setValueMetaData(ValueMetaData valueMetaData)

getValueMetaData

public ValueMetaData getValueMetaData()

getPropertyMetaData

public PropertyMetaData getPropertyMetaData()

setPropertyMetaData

public void setPropertyMetaData(PropertyMetaData propertyMetaData)

getMapEntryMetaData

public MapEntryMetaData getMapEntryMetaData()

setMapEntryMetaData

public void setMapEntryMetaData(MapEntryMetaData mapEntryMetaData)

setSkip

public void setSkip(boolean skip)

isSkip

public boolean isSkip()

getCharactersMetaData

public CharactersMetaData getCharactersMetaData()

setCharactersMetaData

public void setCharactersMetaData(CharactersMetaData charMetaData)

setAddMethodMetaData

public void setAddMethodMetaData(AddMethodMetaData addMethodMetaData)

getAddMethodMetaData

public AddMethodMetaData getAddMethodMetaData()

getValueAdapter

public ValueAdapter getValueAdapter()

setValueAdapter

public void setValueAdapter(ValueAdapter valueAdapter)

isStartElementCreatesObject

public boolean isStartElementCreatesObject()
Whether the ParticleHandler should return a non-null object from its startParticle method. This should be true for any type that has child elements and/or attributes, i.e. complex types. If the type is simple or it's a complex type that should be treated as a simple type then this value should be false.

Returns:

setStartElementCreatesObject

public void setStartElementCreatesObject(boolean startElementCreatesObject)
Whether the ParticleHandler should return a non-null object from its startParticle method. This should be true for any type that has child elements and/or attributes, i.e. complex types. If the type is simple or it's a complex type that should be treated as a simple type then this value should be false.

Parameters:
startElementCreatesObject -

getWildcard

public WildcardBinding getWildcard()

getParticle

public ParticleBinding getParticle()

setParticle

public void setParticle(ParticleBinding particle)

getLexicalPattern

public List<String> getLexicalPattern()

addLexicalPattern

public void addLexicalPattern(String patternValue)

getLexicalEnumeration

public List<String> getLexicalEnumeration()

addEnumValue

public void addEnumValue(String value)

setItemType

public void setItemType(TypeBinding itemType)

getItemType

public TypeBinding getItemType()

getXopUnmarshaller

public XOPUnmarshaller getXopUnmarshaller()

setXopUnmarshaller

public void setXopUnmarshaller(XOPUnmarshaller xopUnmarshaller)

getXopMarshaller

public XOPMarshaller getXopMarshaller()

setXopMarshaller

public void setXopMarshaller(XOPMarshaller xopMarshaller)

hasOnlyXmlMimeAttributes

public boolean hasOnlyXmlMimeAttributes()

setBeforeMarshallingCallback

public void setBeforeMarshallingCallback(TermBeforeMarshallingCallback marshallingHandler)

getBeforeMarshallingCallback

public TermBeforeMarshallingCallback getBeforeMarshallingCallback()

setBeforeSetParentCallback

public void setBeforeSetParentCallback(TermBeforeSetParentCallback beforeSetParent)

getBeforeSetParentCallback

public TermBeforeSetParentCallback getBeforeSetParentCallback()

isIgnoreEmptyString

public boolean isIgnoreEmptyString()

setIgnoreEmptyString

public void setIgnoreEmptyString(boolean value)

getAnyAttribute

public AnyAttributeBinding getAnyAttribute()

setAnyAttribute

public void setAnyAttribute(AnyAttributeBinding anyAttribute)

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2010 JBoss, a division of Red Hat, Inc.. All Rights Reserved.