org.cip4.jdflib.extensions

Class BaseXJDFHelper

java.lang.Object

org.cip4.jdflib.extensions.BaseXJDFHelper

Direct Known Subclasses:

IntentHelper, MessageHelper, MessagePoolHelper, ProductHelper, ResourceHelper, SetHelper, XJDFHelper

public abstract class BaseXJDFHelper
extends Object

Author:

rainer prosi

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	log
protected KElement	theElement

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseXJDFHelper()
protected	BaseXJDFHelper(KElement theElement)

Method Summary

Modifier and Type	Method and Description
KElement	appendElement(String elementName)
void	cleanUp() generic cleanup routine
KElement	copyHelper(BaseXJDFHelper src)
KElement	deleteNode()
String	ensureID() get the ID from the generic Parameter or Resource element
boolean	equals(Object obj) equals and hash are based on the xml element that this helper represents
String	getAttribute(String attName)
KElement	getCreateElement(String nodeName)
String	getGeneralID(String idUsage)
String	getID() get the ID from the generic Parameter or Resource element
KElement	getRoot()
KElement	getXPathElement(String xpath)
String	getXPathValue(String xpath)
int	hashCode() equals and hash are based on the xml element that this helper represents
boolean	isEqual(BaseXJDFHelper other)
void	removeAttribute(String attrib, String nameSpaceURI)
void	reorder() reorder elements in their canonical order - usually nop
void	setAttribute(String attName, String value)
void	setGeneralID(String idUsage, String idValue)
void	setID(String newID)
void	setXPathValue(String xpath, String value)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

log

protected final org.apache.commons.logging.Log log

theElement

protected KElement theElement

Constructor Detail

BaseXJDFHelper

protected BaseXJDFHelper()

BaseXJDFHelper

protected BaseXJDFHelper(KElement theElement)

Method Detail

getXPathValue

public String getXPathValue(String xpath)

Parameters:

xpath -

Returns:

getXPathElement

public KElement getXPathElement(String xpath)

Parameters:

xpath -

Returns:

getAttribute

public String getAttribute(String attName)

Parameters:

attName -

Returns:

removeAttribute

public void removeAttribute(String attrib,
                            String nameSpaceURI)

Parameters:

attrib -

nameSpaceURI -

setAttribute

public void setAttribute(String attName,
                         String value)

Parameters:

attName -

value -

reorder

public void reorder()

reorder elements in their canonical order - usually nop

setXPathValue

public void setXPathValue(String xpath,
                          String value)

Parameters:

xpath -

value -

cleanUp

public void cleanUp()

generic cleanup routine

getRoot

public KElement getRoot()

Returns:

the underlying element

deleteNode

public KElement deleteNode()

Returns:

isEqual

public boolean isEqual(BaseXJDFHelper other)

Returns:

getID

public String getID()

get the ID from the generic Parameter or Resource element

Returns:

the ID , may be null

ensureID

public String ensureID()

get the ID from the generic Parameter or Resource element

Returns:

the ID , may never be null

setID

public void setID(String newID)

Parameters:

newID -

hashCode

public int hashCode()

equals and hash are based on the xml element that this helper represents

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

equals and hash are based on the xml element that this helper represents

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

toString

public String toString()

Overrides:

toString in class Object

Returns:

See Also:

Object.toString()

appendElement

public KElement appendElement(String elementName)

Parameters:

elementName -

Returns:

See Also:

KElement.appendElement(java.lang.String)

copyHelper

public KElement copyHelper(BaseXJDFHelper src)

Parameters:

nodeName -

Returns:

See Also:

KElement.getCreateElement(java.lang.String)

getCreateElement

public KElement getCreateElement(String nodeName)

Parameters:

nodeName -

Returns:

See Also:

KElement.getCreateElement(java.lang.String)

setGeneralID

public void setGeneralID(String idUsage,
                         String idValue)

Parameters:

idUsage -

idValue -

getGeneralID

public String getGeneralID(String idUsage)

Parameters:

idUsage -

idValue -