quadbase.common.util.internal

Class XMLFieldInfo

java.lang.Object

quadbase.common.util.internal.XMLFieldInfo

public class XMLFieldInfo
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	VERSION
static java.lang.String	XMLTAG

Constructor Summary

Constructors

Constructor and Description
XMLFieldInfo() Default constructor
XMLFieldInfo(java.lang.String[] path) Create a XMLFieldInfo object from path, a string array
XMLFieldInfo(java.lang.String[] path, java.lang.String attrName) Create a XMLFieldInfo object from path and a specified attribute

Method Summary

Modifier and Type	Method and Description
static java.lang.String	createAttributeNameFromString(java.lang.String str) for internal use only
static java.lang.String	createAttributeNameFromString(java.lang.String str, java.lang.String delimiter) for internal use only
static java.lang.String[]	createPathFromString(java.lang.String pathStr) for internal use only
static java.lang.String[]	createPathFromString(java.lang.String pathStr, java.lang.String delimiter) for internal use only
static XMLFieldInfo	createXMLFieldInfo(java.io.DataInput in, int version) for internal use only
static XMLFieldInfo	createXMLFieldInfo(java.io.DataInput in, int version, boolean decode) for internal use only
boolean	equalsPath(XMLFieldInfo tmp) for internal use only
java.lang.String	getAlias() Return the alias of this field If no alias defined, return the path string
java.lang.String	getAttributeDataType() Returns the attribute data type
java.lang.String	getAttributeName() Returns the attribute name
java.lang.String	getColumnName()
java.lang.String	getDataType()
java.lang.String	getDateFormat() Returns the date format
java.lang.String	getDisplayName() for internal use only
static java.lang.String	getDisplayName(java.lang.String[] path, java.lang.String attrName) for internal use only
java.lang.String	getElementDataType() Returns the element data type
java.lang.String[]	getPath() for internal use only
java.lang.String	getPathToString() for internal use only
int	getXMLType() Returns the XML type
boolean	isExpandable() for internal use only
boolean	isRecursive() for internal use only
boolean	isRequired() for internal use only
static XMLFieldInfo	readXML(org.w3c.dom.Node dnode, int version) for internal use only
void	setAlias(java.lang.String alias) Sets the alias of this field
void	setAttributeDataType(java.lang.String type) Sets the attribute data type
void	setAttributeName(java.lang.String attr) Sets the attribute name
void	setDateFormat(java.lang.String format) Sets the date format
void	setElementDataType(java.lang.String type) Sets the element data type
void	setIsExpandable(boolean state) for internal use only
void	setIsRequired(boolean state) for internal use only
void	setPath(java.lang.String[] path) for internal use only
void	setRecursive(boolean state) for internal use only
void	setXMLType(int type) Sets the xml type
java.lang.String	toString() Returns the string representation of this field
void	write(java.io.DataOutput out) for internal use only
void	write(java.io.DataOutput out, boolean encode) for internal use only
void	writeXML(java.io.Writer dout) for internal use only

Methods inherited from class java.lang.Object

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

Field Detail

XMLTAG

public static final java.lang.String XMLTAG

See Also:

Constant Field Values

VERSION

public static final int VERSION

See Also:

Constant Field Values

Constructor Detail

XMLFieldInfo

public XMLFieldInfo()

Default constructor

XMLFieldInfo

public XMLFieldInfo(java.lang.String[] path)

Create a XMLFieldInfo object from path, a string array

Parameters:

path - , a string array represents the path to this field

XMLFieldInfo

public XMLFieldInfo(java.lang.String[] path,
                    java.lang.String attrName)

Create a XMLFieldInfo object from path and a specified attribute

Parameters:

path - , a string array represents the path to the element

attrName - , the attribute name

Method Detail

equalsPath

public boolean equalsPath(XMLFieldInfo tmp)

for internal use only

getPath

public java.lang.String[] getPath()

for internal use only

setPath

public void setPath(java.lang.String[] path)

for internal use only

getDisplayName

public java.lang.String getDisplayName()

for internal use only

getPathToString

public java.lang.String getPathToString()

for internal use only

getColumnName

public java.lang.String getColumnName()

getDisplayName

public static java.lang.String getDisplayName(java.lang.String[] path,
                                              java.lang.String attrName)

for internal use only

createPathFromString

public static java.lang.String[] createPathFromString(java.lang.String pathStr)

for internal use only

createPathFromString

public static java.lang.String[] createPathFromString(java.lang.String pathStr,
                                                      java.lang.String delimiter)

for internal use only

createAttributeNameFromString

public static java.lang.String createAttributeNameFromString(java.lang.String str)

for internal use only

createAttributeNameFromString

public static java.lang.String createAttributeNameFromString(java.lang.String str,
                                                             java.lang.String delimiter)

for internal use only

getElementDataType

public java.lang.String getElementDataType()

Returns the element data type

Returns:

a string that represents the element data type

setElementDataType

public void setElementDataType(java.lang.String type)

Sets the element data type

Parameters:

type - a string represents the element data type

getAttributeDataType

public java.lang.String getAttributeDataType()

Returns the attribute data type

Returns:

a string that represents the attribute data type

setAttributeDataType

public void setAttributeDataType(java.lang.String type)

Sets the attribute data type

Parameters:

type - a string represents the attribute data type

getAttributeName

public java.lang.String getAttributeName()

Returns the attribute name

Returns:

a string that represents the attribute name

setAttributeName

public void setAttributeName(java.lang.String attr)

Sets the attribute name

Parameters:

attr - a string represents the attribute name

getDateFormat

public java.lang.String getDateFormat()

Returns the date format

Returns:

the date format

setDateFormat

public void setDateFormat(java.lang.String format)

Sets the date format

Parameters:

the - date format

getDataType

public java.lang.String getDataType()

getXMLType

public int getXMLType()

Returns the XML type

Returns:

an integer, the xml type of this field

setXMLType

public void setXMLType(int type)

Sets the xml type

Parameters:

type - , an integer of xml type

isExpandable

public boolean isExpandable()

for internal use only

setIsExpandable

public void setIsExpandable(boolean state)

for internal use only

isRequired

public boolean isRequired()

for internal use only

setIsRequired

public void setIsRequired(boolean state)

for internal use only

isRecursive

public boolean isRecursive()

for internal use only

setRecursive

public void setRecursive(boolean state)

for internal use only

getAlias

public java.lang.String getAlias()

Return the alias of this field If no alias defined, return the path string

setAlias

public void setAlias(java.lang.String alias)

Sets the alias of this field

Parameters:

alias - , a string represents the alias of this field

write

public void write(java.io.DataOutput out)
           throws java.io.IOException

for internal use only

Throws:

java.io.IOException

write

public void write(java.io.DataOutput out,
                  boolean encode)
           throws java.io.IOException

for internal use only

Throws:

java.io.IOException

createXMLFieldInfo

public static XMLFieldInfo createXMLFieldInfo(java.io.DataInput in,
                                              int version)
                                       throws java.io.IOException

for internal use only

Throws:

java.io.IOException

createXMLFieldInfo

public static XMLFieldInfo createXMLFieldInfo(java.io.DataInput in,
                                              int version,
                                              boolean decode)
                                       throws java.io.IOException

for internal use only

Throws:

java.io.IOException

writeXML

public void writeXML(java.io.Writer dout)
              throws java.io.IOException

for internal use only

Throws:

java.io.IOException

readXML

public static XMLFieldInfo readXML(org.w3c.dom.Node dnode,
                                   int version)
                            throws java.lang.Exception

for internal use only

Throws:

java.lang.Exception

toString

public java.lang.String toString()

Returns the string representation of this field

Overrides:

toString in class java.lang.Object