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 java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected static 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(java.lang.String elementName)
void	cleanUp() generic cleanup routine
KElement	copyHelper(BaseXJDFHelper src)
KElement	deleteNode()
java.lang.String	ensureID() get the ID from the generic Parameter or Resource element
boolean	equals(java.lang.Object obj) equals and hash are based on the xml element that this helper represents
java.lang.String	getAttribute(java.lang.String attName)
java.lang.String	getComment(int i)
KElement	getCreateElement(java.lang.String nodeName)
static JDFElement.EnumVersion	getDefaultVersion()
java.lang.String	getDescriptiveName()
java.lang.String	getExternalID()
java.lang.String	getGeneralID(java.lang.String idUsage)
java.lang.String	getID() get the ID from the generic Parameter or Resource element
java.lang.String	getLocalName()
KElement	getRoot()
KElement	getXPathElement(java.lang.String xpath)
java.lang.String	getXPathValue(java.lang.String xpath)
BaseXJDFHelper	getXRoot()
boolean	hasAttribute(java.lang.String attName)
int	hashCode() equals and hash are based on the xml element that this helper represents
boolean	isEqual(BaseXJDFHelper other)
void	removeAttribute(java.lang.String attrib, java.lang.String nameSpaceURI)
void	setAttribute(java.lang.String attName, java.lang.String value)
JDFComment	setComment(java.lang.String text)
static void	setDefaultVersion(JDFElement.EnumVersion defaultVersion)
void	setID(java.lang.String newID)
void	setXPathValue(java.lang.String xpath, java.lang.String value)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

log

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

theElement

protected KElement theElement

Constructor Detail

BaseXJDFHelper

protected BaseXJDFHelper()

BaseXJDFHelper

protected BaseXJDFHelper(KElement theElement)

Method Detail

getDefaultVersion

public static JDFElement.EnumVersion getDefaultVersion()

Returns:

the defaultVersion

setDefaultVersion

public static void setDefaultVersion(JDFElement.EnumVersion defaultVersion)

Parameters:

defaultVersion - the defaultVersion to set

getXPathValue

public java.lang.String getXPathValue(java.lang.String xpath)

Parameters:

xpath -

Returns:

getXPathElement

public KElement getXPathElement(java.lang.String xpath)

Parameters:

xpath -

Returns:

getAttribute

public java.lang.String getAttribute(java.lang.String attName)

Parameters:

attName -

Returns:

hasAttribute

public boolean hasAttribute(java.lang.String attName)

Parameters:

attName -

Returns:

removeAttribute

public void removeAttribute(java.lang.String attrib,
                            java.lang.String nameSpaceURI)

Parameters:

attrib -

nameSpaceURI -

setAttribute

public void setAttribute(java.lang.String attName,
                         java.lang.String value)

Parameters:

attName -

value -

setXPathValue

public void setXPathValue(java.lang.String xpath,
                          java.lang.String value)

Parameters:

xpath -

value -

cleanUp

public void cleanUp()

generic cleanup routine

getRoot

public KElement getRoot()

Returns:

the underlying element

getXRoot

public BaseXJDFHelper getXRoot()

Returns:

the underlying element

deleteNode

public KElement deleteNode()

Returns:

isEqual

public boolean isEqual(BaseXJDFHelper other)

Returns:

getID

public java.lang.String getID()

get the ID from the generic Parameter or Resource element

Returns:

the ID , may be null

ensureID

public java.lang.String ensureID()

get the ID from the generic Parameter or Resource element

Returns:

the ID , may never be null

setID

public void setID(java.lang.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 java.lang.Object

See Also:

Object.hashCode()

equals

public boolean equals(java.lang.Object obj)

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

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

See Also:

Object.toString()

appendElement

public KElement appendElement(java.lang.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(java.lang.String nodeName)

Parameters:

nodeName -

Returns:

See Also:

KElement.getCreateElement(java.lang.String)

getLocalName

public java.lang.String getLocalName()

Returns:

the local name of the root

getGeneralID

public java.lang.String getGeneralID(java.lang.String idUsage)

Parameters:

idUsage -

idValue -

getComment

public java.lang.String getComment(int i)

Returns:

the comment text

setComment

public JDFComment setComment(java.lang.String text)

Returns:

the comment

getExternalID

public java.lang.String getExternalID()

Returns:

the productID of the product

getDescriptiveName

public java.lang.String getDescriptiveName()

Returns:

the descriptive name of the product