public abstract class WrapperDefElement extends java.lang.Object implements DefElement
DefElement
interface
by creating a wrapper around some sort of object that behaves
roughly like an immutable Element
.
The concrete subclasses ElementDefElement
and
MElementDefElement
use an Element
or an
MElement
as the wrapped object.
DefElement
NODETYPES_TEXT_CDATA
ATTRIBUTE_NODE, CDATA_SECTION_NODE, ELEMENT_NODE, TEXT_NODE
Constructor and Description |
---|
WrapperDefElement() |
Modifier and Type | Method and Description |
---|---|
DefElement |
findChildElement(java.lang.String childName)
Finds the first child element of the given node name
|
abstract java.lang.String |
getAttribute(java.lang.String param1) |
org.w3c.dom.NamedNodeMap |
getAttributes() |
abstract java.util.ArrayList |
getAttrsList()
Gets all the attributes of the element, in no particular order.
|
org.w3c.dom.NodeList |
getChildNodes() |
java.util.Vector |
getChildren(java.lang.String childName)
Gets the child elements of the given node name.
|
org.w3c.dom.NodeList |
getChildrenByTagName(java.lang.String sName) |
org.w3c.dom.NodeList |
getChildrenByTagName(java.lang.String uri,
java.lang.String localName) |
java.util.ArrayList |
getChildrenList()
Gets all the child elements.
|
java.util.ArrayList |
getChildrenList(short[] nodeTypes)
Gets all the child nodes of the given types.
|
abstract java.util.ArrayList |
getChildrenList(short[] nodeTypes,
java.lang.String childName)
Gets the child nodes of the given types and node name.
|
java.util.ArrayList |
getChildrenList(java.lang.String childName)
Gets the child elements of the given node name.
|
java.lang.String |
getElementName()
Retrieves the node name of the element as a string.
|
protected abstract DefElement |
getFirstChildByTagName(java.lang.String name) |
protected abstract DefElement |
getFirstElementByTagName(java.lang.String name)
Returns the first
DefElement descendant (preorder)
with the specified tag name. |
protected abstract DefElement |
getImmediateFirstElementByTagName(java.lang.String name)
Returns the first immediate child with the specified tag name.
|
abstract java.lang.String |
getLocalName() |
abstract java.lang.String |
getNamespaceURI() |
abstract java.lang.String |
getNodeName() |
short |
getNodeType() |
java.lang.String |
getNodeValue() |
org.w3c.dom.Document |
getOwnerDocument() |
java.util.Vector |
getSimilarChildren(java.lang.String childName)
Gets the child elements with node names "similar to" the given node name
(i.e.
|
abstract java.util.ArrayList |
getSimilarChildrenList(java.lang.String childName)
Gets the child elements with node names "similar to" the given node name
(i.e.
|
java.lang.String |
getTagName() |
java.util.Hashtable |
loadProperties()
Loads the Jbo Properties
|
java.util.HashMap |
loadPropertiesMap()
Loads the Jbo Properties
|
java.util.Hashtable |
loadTable(java.lang.String attrName,
java.lang.String elemName,
java.lang.String name,
java.lang.String value) |
java.util.HashMap |
loadTableMap(java.lang.String attrName,
java.lang.String elemName,
java.lang.String name,
java.lang.String value) |
java.util.List<java.util.List<java.lang.String>> |
read2DStringArray(java.lang.String parentName,
java.lang.String firstElement,
java.lang.String secondElement)
This method reads a 2D hierarchical element structure from under the parent element into
a list of list of strings
The element structure that is read into the 2D list looks like:
|
boolean |
readBoolean(java.lang.String attrName)
Given the Object name and Attribute name loads that attribute
|
java.lang.String |
readCDataObject(java.lang.String attrName) |
java.lang.Class |
readClassName(java.lang.String attrName) |
int |
readInt(java.lang.String attrName)
Given the Object name and Attribute name loads that attribute
and returns the int value.
|
long |
readLong(java.lang.String attrName)
Given the Object name and Attribute name loads that attribute
|
java.lang.String |
readString(java.lang.String attrName)
Given the Object name and Attribute name loads that attribute
|
java.util.Vector |
readStringArray(java.lang.String attrName)
Given the Attribute name loads the array
|
java.util.ArrayList |
readStringArrayList(java.lang.String attrName)
Given the Attribute name loads the array
|
java.util.ArrayList |
readStringArrayListElement(java.lang.String attrName)
Given the Attribute name loads the array
|
java.lang.String |
readUserNodeValue(java.lang.String attrName)
Given the Object name and Attribute name loads that attribute
|
java.lang.String |
readUserObject(java.lang.String attrName) |
java.lang.String |
readUserObject(java.lang.String attrName,
boolean checkUnique) |
java.lang.String |
readUserObjectTrim(java.lang.String attrName) |
java.lang.String |
readUserObjectTrim(java.lang.String attrName,
boolean checkUnique) |
java.util.ArrayList |
readUserStringArrayListElement(java.lang.String elemName)
Given the Attribute name loads the array
|
java.util.HashMap |
readUserStringElementsMap(java.lang.String elemName) |
void |
removeAttribute(java.lang.String param1) |
void |
setAttribute(java.lang.String param1,
java.lang.String param2) |
public abstract java.lang.String getLocalName()
getLocalName
in interface DefNode
public abstract java.lang.String getNamespaceURI()
getNamespaceURI
in interface DefNode
public abstract java.lang.String getNodeName()
getNodeName
in interface DefNode
public short getNodeType()
getNodeType
in interface DefNode
public java.lang.String getNodeValue()
getNodeValue
in interface DefNode
public java.lang.String getElementName()
DefElement
getElementName
in interface DefElement
public java.util.Vector getChildren(java.lang.String childName)
DefElement
getChildren
in interface DefElement
childName
- the node name of the child - null indicates all names.public DefElement findChildElement(java.lang.String childName)
DefElement
findChildElement
in interface DefElement
childName
- the node name of the child - null indicates all names.public java.util.ArrayList getChildrenList()
DefElement
getChildrenList
in interface DefElement
public java.util.ArrayList getChildrenList(short[] nodeTypes)
DefElement
getChildrenList
in interface DefElement
nodeTypes
- the types of nodes to be retrieved. Notes:
(1) Only ELEMENT_NODE, TEXT_NODE, and
CDATA_SECTION_NODE are currently supported.
(2) The order in which node types are listed
has no effect, even on performance.public java.util.ArrayList getChildrenList(java.lang.String childName)
DefElement
getChildrenList
in interface DefElement
childName
- the node name of the child - null indicates all names.public abstract java.util.ArrayList getChildrenList(short[] nodeTypes, java.lang.String childName)
DefElement
getChildrenList
in interface DefElement
nodeTypes
- the types of nodes to be retrieved. Notes:
(1) Only ELEMENT_NODE, TEXT_NODE, and
CDATA_SECTION_NODE are currently supported.
(2) The order in which node types are listed
has no effect, even on performance.childName
- the node name of the child - null indicates all names.public java.util.Vector getSimilarChildren(java.lang.String childName)
DefElement
getSimilarChildren
in interface DefElement
childName
- the substring within node name of the child.public abstract java.util.ArrayList getSimilarChildrenList(java.lang.String childName)
DefElement
getSimilarChildrenList
in interface DefElement
childName
- the Substring within node name of the child.public abstract java.util.ArrayList getAttrsList()
DefElement
getAttrsList
in interface DefElement
public int readInt(java.lang.String attrName)
DefElement
readInt
in interface DefElement
attrName
- Name of the Attributepublic long readLong(java.lang.String attrName)
DefElement
readLong
in interface DefElement
attrName
- Name of the Attributepublic boolean readBoolean(java.lang.String attrName)
DefElement
readBoolean
in interface DefElement
attrName
- Name of the Attributepublic java.lang.String readString(java.lang.String attrName)
DefElement
readString
in interface DefElement
attrName
- Name of the Attributepublic java.lang.String readCDataObject(java.lang.String attrName)
readCDataObject
in interface DefElement
public java.lang.String readUserObject(java.lang.String attrName)
readUserObject
in interface DefElement
public java.lang.String readUserObject(java.lang.String attrName, boolean checkUnique)
readUserObject
in interface DefElement
public java.lang.String readUserObjectTrim(java.lang.String attrName)
readUserObjectTrim
in interface DefElement
public java.lang.String readUserObjectTrim(java.lang.String attrName, boolean checkUnique)
readUserObjectTrim
in interface DefElement
public java.lang.String readUserNodeValue(java.lang.String attrName)
DefElement
readUserNodeValue
in interface DefElement
attrName
- Name of the Attributepublic java.util.Vector readStringArray(java.lang.String attrName)
DefElement
readStringArray
in interface DefElement
attrName
- Name of the Attributepublic java.util.ArrayList readStringArrayList(java.lang.String attrName)
DefElement
readStringArrayList
in interface DefElement
attrName
- Name of the Attributepublic java.util.ArrayList readStringArrayListElement(java.lang.String attrName)
DefElement
readStringArrayListElement
in interface DefElement
attrName
- Name of the Attributepublic java.lang.Class readClassName(java.lang.String attrName)
readClassName
in interface DefElement
public java.util.Hashtable loadProperties()
DefElement
loadProperties
in interface DefElement
public java.util.HashMap loadPropertiesMap()
DefElement
loadPropertiesMap
in interface DefElement
public java.util.Hashtable loadTable(java.lang.String attrName, java.lang.String elemName, java.lang.String name, java.lang.String value)
loadTable
in interface DefElement
public java.util.HashMap loadTableMap(java.lang.String attrName, java.lang.String elemName, java.lang.String name, java.lang.String value)
loadTableMap
in interface DefElement
public java.lang.String getTagName()
getTagName
in interface DefElement
public abstract java.lang.String getAttribute(java.lang.String param1)
getAttribute
in interface DefElement
public void setAttribute(java.lang.String param1, java.lang.String param2)
setAttribute
in interface DefElement
public void removeAttribute(java.lang.String param1)
removeAttribute
in interface DefElement
public org.w3c.dom.NamedNodeMap getAttributes()
getAttributes
in interface DefElement
public org.w3c.dom.NodeList getChildNodes()
getChildNodes
in interface DefElement
public org.w3c.dom.NodeList getChildrenByTagName(java.lang.String sName)
getChildrenByTagName
in interface DefElement
public org.w3c.dom.NodeList getChildrenByTagName(java.lang.String uri, java.lang.String localName)
getChildrenByTagName
in interface DefElement
public org.w3c.dom.Document getOwnerDocument()
getOwnerDocument
in interface DefElement
protected abstract DefElement getImmediateFirstElementByTagName(java.lang.String name)
name
- The tag name to match on, or "*" for first child.null
if none).protected abstract DefElement getFirstChildByTagName(java.lang.String name)
protected abstract DefElement getFirstElementByTagName(java.lang.String name)
DefElement
descendant (preorder)
with the specified tag name.name
- The tag name to match on.null
if none).public java.util.ArrayList readUserStringArrayListElement(java.lang.String elemName)
DefElement
readUserStringArrayListElement
in interface DefElement
elemName
- Name of the child element that is a list of CData stringspublic java.util.HashMap readUserStringElementsMap(java.lang.String elemName)
readUserStringElementsMap
in interface DefElement
public java.util.List<java.util.List<java.lang.String>> read2DStringArray(java.lang.String parentName, java.lang.String firstElement, java.lang.String secondElement)
DefElement
read2DStringArray
in interface DefElement
parentName
- - Name of the parent element under which this 2D structure is presentfirstElement
- - Name of the first level elementsecondElement
- - Name of the second level element