Package wt.ixb.impl.jaxb

Class IxbJaxbElement

java.lang.Object

wt.ixb.impl.jaxb.IxbJaxbElement

All Implemented Interfaces:

IxbElement

Direct Known Subclasses:

IxbJaxbDocElement

public class IxbJaxbElement
extends Object
implements IxbElement

This class use JAXB Object to store attributes and elements It uses JAXBUtil class to set/get value of JAXB object

Supported API: true

Extendable: true

Method Summary

Modifier and Type	Method	Description
void	addAttribute(String name, String value)	add Attribute to current element Supported API: true
IxbElement	addCDataSectionValue(String key, String value)	add CDataSection Value to current element, not supported no Supported API: true
IxbElement	addElement(String key)	add element to current JAXB Object, may be multiple Supported API: true
void	addElement(IxbElement el)	add given IxbElement as child element Currenty it isn't be called by outer directly, because we didn't need to initialize a JAXBElement Supported API: true
void	addForeignElementByCopy(IxbElement el)	Makes foreign elem native by copy - i.e.
IxbElement	addValue(String tag, boolean value)	add boolean value Supported API: true
IxbElement	addValue(String tag, double value)	add double value Supported API: true
IxbElement	addValue(String tag, int value)	add int value Supported API: true
IxbElement	addValue(String tag, long value)	add long value Supported API: true
IxbElement	addValue(String tag, String value)	add String value Supported API: true
String	getAttribute(String tag)	get attribute for give tag Supported API: true
Enumeration	getAttributes()	get all mapped attribute values Supported API: true
Hashtable	getAttributeValuePairs()	Returns Hashtable of pairs: (attrName, attrValue) Supported API: true
Boolean	getBooleanValue(String tag)	get boolean value Supported API: true
Map<String,Object>	getChildren()	get the value of children Supported API: true
Map<String,Map<String,List<Object>>>	getChildrenMap()	get the value of childrenMap Supported API: true
Double	getDoubleValue(String tag)	get Double value Supported API: true
IxbElement	getElement(String tag)	get first element by give tag name Supported API: true
Enumeration	getElements()	get all Elements Supported API: true
Enumeration	getElements(String tag)	get all the elements by tag name Supported API: true
Map<String,Object>	getElementValueMap()	get the value of plcsValueMap Supported API: true
Map<String,List<IxbElement>>	getForeignMap()	get the value of foreignMap Supported API: true
Integer	getIntValue(String tag)	get int value Supported API: true
Iterator	getKeys()	get attributes keys Supported API: true
Long	getLongValue(String tag)	get long value Supported API: true
IxbElement	getParent()	get parent element Supported API: true
Object	getRootObject()	get the value of rootObject Supported API: true
String	getSchemaType()	get the value of schemaType Supported API: true
Map<String,Map<String,List<IxbElement>>>	getSubForeignMap()	get the value of subForeignMap Supported API: true
String	getTag()	get tag name Supported API: true
QName	getTagQName()	get the value of tagQName Supported API: true
String	getValue()	get value of element, only support when the root object value is string type.
String	getValue(String tag)	get value from current JAXB Element Supported API: true
Enumeration	getValues(String tag)	get values by tag Supported API: true
boolean	isCDATASectionElement()	isCDATASectionElement Supported API: true
boolean	isCommentElement()	isCommentElement Supported API: true
boolean	isMultiple()	get the value of multiple Supported API: true
boolean	isNeedSchemaCheck()	get the value of needSchemaCheck Supported API: true
boolean	isTextElement()	isTextElement Supported API: true
void	removeChildElement(IxbElement el)	remove child element from current one Supported API: true
void	setMultiple(boolean multiple)	set the value of multiple Supported API: true
void	setNeedSchemaCheck(boolean needSchemaCheck)	set the value of needSchemaCheck Supported API: true
IxbElement	setValue(String key, String newValue)	set value to current element Supported API: true
File	store(File xmlFile, String dtdName)	store current element into a file Supported API: true
void	store(OutputStream os, String dtdName)	store current element into an OutputStream Supported API: true
String	store(String dtdName)	store current element as a string Supported API: true

Methods inherited from class java.lang.Object

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

Method Details

addAttribute

public void addAttribute(String name,
 String value)
                  throws WTException

add Attribute to current element

Supported API: true

Specified by:

addAttribute in interface IxbElement

Parameters:

name -

value -

Throws:

WTException

addCDataSectionValue

public IxbElement addCDataSectionValue(String key,
 String value)
                                throws WTException

add CDataSection Value to current element, not supported no

Supported API: true

Specified by:

addCDataSectionValue in interface IxbElement

Parameters:

key -

value -

Returns:

IxbElement

Throws:

WTException

addElement

public IxbElement addElement(String key)
                      throws WTException

add element to current JAXB Object, may be multiple

Supported API: true

Specified by:

addElement in interface IxbElement

Parameters:

key -

Returns:

IxbElement

Throws:

WTException

addElement

public void addElement(IxbElement el)
                throws WTException

add given IxbElement as child element Currenty it isn't be called by outer directly, because we didn't need to initialize a JAXBElement

Supported API: true

Specified by:

addElement in interface IxbElement

Parameters:

el -

Throws:

WTException

addForeignElementByCopy

public void addForeignElementByCopy(IxbElement el)
                             throws WTException

Makes foreign elem native by copy - i.e. by importNode()

Supported API: true

Specified by:

addForeignElementByCopy in interface IxbElement

Parameters:

el -

Throws:

WTException

addValue

public IxbElement addValue(String tag,
 String value)
                    throws WTException

add String value

Supported API: true

Specified by:

addValue in interface IxbElement

Parameters:

key -

value -

Returns:

IxbElement

Throws:

WTException

addValue

public IxbElement addValue(String tag,
 int value)
                    throws WTException

add int value

Supported API: true

Specified by:

addValue in interface IxbElement

Parameters:

key -

value -

Returns:

IxbElement

Throws:

WTException

addValue

public IxbElement addValue(String tag,
 long value)
                    throws WTException

add long value

Supported API: true

Specified by:

addValue in interface IxbElement

Parameters:

key -

value -

Returns:

IxbElement

Throws:

WTException

addValue

public IxbElement addValue(String tag,
 boolean value)
                    throws WTException

add boolean value

Supported API: true

Specified by:

addValue in interface IxbElement

Parameters:

key -

value -

Returns:

IxbElement

Throws:

WTException

addValue

public IxbElement addValue(String tag,
 double value)
                    throws WTException

add double value

Supported API: true

Specified by:

addValue in interface IxbElement

Parameters:

key -

value -

Returns:

IxbElement

Throws:

WTException

getAttribute

public String getAttribute(String tag)
                    throws WTException

get attribute for give tag

Supported API: true

Specified by:

getAttribute in interface IxbElement

Parameters:

tag -

Returns:

String

Throws:

WTException

getAttributeValuePairs

public Hashtable getAttributeValuePairs()
                                 throws WTException

Returns Hashtable of pairs: (attrName, attrValue)

Supported API: true

Specified by:

getAttributeValuePairs in interface IxbElement

Returns:

Hashtable

Throws:

WTException

getAttributes

public Enumeration getAttributes()
                          throws WTException

get all mapped attribute values

Supported API: true

Specified by:

getAttributes in interface IxbElement

Returns:

Enumeration

Throws:

WTException

getBooleanValue

public Boolean getBooleanValue(String tag)
                        throws WTException

get boolean value

Supported API: true

Specified by:

getBooleanValue in interface IxbElement

Parameters:

tag -

Returns:

Boolean

Throws:

WTException

getDoubleValue

public Double getDoubleValue(String tag)
                      throws WTException

get Double value

Supported API: true

Specified by:

getDoubleValue in interface IxbElement

Parameters:

tag -

Returns:

Double

Throws:

WTException

getElement

public IxbElement getElement(String tag)
                      throws WTException

get first element by give tag name

Supported API: true

Specified by:

getElement in interface IxbElement

Parameters:

tag -

Returns:

IxbElement

Throws:

WTException

getElements

public Enumeration getElements()
                        throws WTException

get all Elements

Supported API: true

Specified by:

getElements in interface IxbElement

Returns:

Enumeration

Throws:

WTException

getElements

public Enumeration getElements(String tag)
                        throws WTException

get all the elements by tag name

Supported API: true

Specified by:

getElements in interface IxbElement

Returns:

Enumeration

Throws:

WTException

getIntValue

public Integer getIntValue(String tag)
                    throws WTException

get int value

Supported API: true

Specified by:

getIntValue in interface IxbElement

Parameters:

tag -

Returns:

Integer

Throws:

WTException

getKeys

public Iterator getKeys()
                 throws WTException

get attributes keys

Supported API: true

Specified by:

getKeys in interface IxbElement

Returns:

Iterator

Throws:

WTException

getLongValue

public Long getLongValue(String tag)
                  throws WTException

get long value

Supported API: true

Specified by:

getLongValue in interface IxbElement

Parameters:

tag -

Returns:

Long

Throws:

WTException

getParent

public IxbElement getParent()
                     throws WTException

get parent element

Supported API: true

Specified by:

getParent in interface IxbElement

Returns:

String

Throws:

WTException

getTag

public String getTag()
              throws WTException

get tag name

Supported API: true

Specified by:

getTag in interface IxbElement

Returns:

String

Throws:

WTException

getValue

public String getValue()
                throws WTException

get value of element, only support when the root object value is string type.

Supported API: true

Specified by:

getValue in interface IxbElement

Returns:

String

Throws:

WTException

getValue

public String getValue(String tag)
                throws WTException

get value from current JAXB Element

Supported API: true

Specified by:

getValue in interface IxbElement

Parameters:

tag -

Returns:

String

Throws:

WTException

getValues

public Enumeration getValues(String tag)
                      throws WTException

get values by tag

Supported API: true

Specified by:

getValues in interface IxbElement

Parameters:

tag -

Returns:

Enumeration

Throws:

WTException

isCDATASectionElement

public boolean isCDATASectionElement()
                              throws WTException

isCDATASectionElement

Supported API: true

Specified by:

isCDATASectionElement in interface IxbElement

Returns:

boolean

Throws:

WTException

isCommentElement

public boolean isCommentElement()
                         throws WTException

isCommentElement

Supported API: true

Specified by:

isCommentElement in interface IxbElement

Returns:

boolean

Throws:

WTException

isTextElement

public boolean isTextElement()
                      throws WTException

isTextElement

Supported API: true

Specified by:

isTextElement in interface IxbElement

Returns:

boolean

Throws:

WTException

removeChildElement

public void removeChildElement(IxbElement el)
                        throws WTException

remove child element from current one

Supported API: true

Specified by:

removeChildElement in interface IxbElement

Parameters:

el -

Throws:

WTException

setValue

public IxbElement setValue(String key,
 String newValue)
                    throws WTException

set value to current element

Supported API: true

Specified by:

setValue in interface IxbElement

Parameters:

key -

newValue -

Returns:

IxbElement

Throws:

WTException

store

public String store(String dtdName)
             throws WTException

store current element as a string

Supported API: true

Specified by:

store in interface IxbElement

Parameters:

dtdName -

Returns:

String

Throws:

WTException

store

public void store(OutputStream os,
 String dtdName)
           throws WTException

store current element into an OutputStream

Supported API: true

Specified by:

store in interface IxbElement

Parameters:

os -

dtdName -

Throws:

WTException

store

public File store(File xmlFile,
 String dtdName)
           throws WTException

store current element into a file

Supported API: true

Specified by:

store in interface IxbElement

Parameters:

xmlFile -

dtdName -

Returns:

File

Throws:

WTException

getRootObject

public Object getRootObject()

get the value of rootObject

Supported API: true

Returns:

rootObject

getTagQName

public QName getTagQName()

get the value of tagQName

Supported API: true

Returns:

tagQName

setNeedSchemaCheck

public void setNeedSchemaCheck(boolean needSchemaCheck)

set the value of needSchemaCheck

Supported API: true

Parameters:

needSchemaCheck -

getChildren

public Map<String,Object> getChildren()

get the value of children

Supported API: true

Returns:

children

setMultiple

public void setMultiple(boolean multiple)

set the value of multiple

Supported API: true

Parameters:

multiple -

isNeedSchemaCheck

public boolean isNeedSchemaCheck()

get the value of needSchemaCheck

Supported API: true

Returns:

needSchemaCheck

getForeignMap

public Map<String,List<IxbElement>> getForeignMap()

get the value of foreignMap

Supported API: true

Returns:

foreignMap

isMultiple

public boolean isMultiple()

get the value of multiple

Supported API: true

Returns:

multiple

getSubForeignMap

public Map<String,Map<String,List<IxbElement>>> getSubForeignMap()

get the value of subForeignMap

Supported API: true

Returns:

subForeignMap

getChildrenMap

public Map<String,Map<String,List<Object>>> getChildrenMap()

get the value of childrenMap

Supported API: true

Returns:

childrenMap

getElementValueMap

public Map<String,Object> getElementValueMap()

get the value of plcsValueMap

Supported API: true

Returns:

plcsValueMap

getSchemaType

public String getSchemaType()

get the value of schemaType

Supported API: true

Returns:

plcsValueMap