com.novell.nds.dirxml.driver.xds
Interface XDSElement

All Known Subinterfaces:

AssociationElementParent, AssociationElementsParent, CommandElement, OptionsParent, ParamElement, ParamParent, PasswordElementParent, SomeAttrElement, StateParent, TextParent, ValueElementsParent

All Known Implementing Classes:

DescriptionElement, ElementImpl, NonXDSElement, XDSAddAssociationElement, XDSAddAttrElement, XDSAddElement, XDSAddValueElement, XDSAllowAttrElement, XDSAssociationElement, XDSAttrElement, XDSAuthenticationInfoElement, XDSCheckObjectPasswordElement, XDSComponentElement, XDSContactElement, XDSDeleteElement, XDSDriverOptionsElement, XDSDriverStateElement, XDSInstanceElement, XDSModifyAssociationElement, XDSModifyAttrElement, XDSModifyElement, XDSModifyPasswordElement, XDSMoveElement, XDSNewNameElement, XDSOldPasswordElement, XDSParentElement, XDSPasswordElement, XDSProductElement, XDSPublisherOptionsElement, XDSPublisherStateElement, XDSQueryElement, XDSQueryExElement, XDSQueryTokenElement, XDSReadAttrElement, XDSRemoveAssociationElement, XDSRemoveValueElement, XDSRenameElement, XDSSearchAttrElement, XDSServerElement, XDSStatusElement, XDSSubscriberOptionsElement, XDSSubscriberStateElement, XDSUserElement, XDSValueElement

public interface XDSElement

Any element defined in the XDS DTD.

Method Summary

String	attributeValueGet(String someAttrName) Returns the value of attribute someAttrName.
String	attributeValueGet(String someNamespaceName, String someAttrName) Returns the value of attribute someAttrName in namespace someNamespaceName.
void	attributeValueSet(String someAttrName, String someValue) Sets this element's someAttrName attribute to value someValue.
List	childElements() Returns this element's child elements.
Document	domDocument() Returns a reference for this element's DOM document.
Element	domElement() Returns a DOM reference for this element.
String	localName() Returns this element's unprefixed tag name.
String	namespaceName() Returns this element's namespace name.
int	position() Returns the position of this element relative to its parent where the first position is 1.
String	tagName() Returns this element's tag name, including namespace prefix.

Method Detail

domDocument

public Document domDocument()

Returns a reference for this element's DOM document.

Returns:

will not return null

domElement

public Element domElement()

Returns a DOM reference for this element.

Returns:

will not return null

localName

public String localName()

Returns this element's unprefixed tag name.

e.g. if this element's tag name were xds:tag, this method would return tag

Returns:

will not return null

tagName

public String tagName()

Returns this element's tag name, including namespace prefix.

e.g. if this element's tag name were xds:tag, this method would return xds:tag

Returns:

will not return null

namespaceName

public String namespaceName()

Returns this element's namespace name.

e.g. if this element's tag name were xds:tag, and the namespace prefix xds resolved to urn:dirxml:xds, this method would return urn:dirxml:xds

Returns:

may return null

attributeValueGet

public String attributeValueGet(String someNamespaceName,
                                String someAttrName)

Returns the value of attribute someAttrName in namespace someNamespaceName.

Parameters:

someNamespaceName - may be null

someAttrName - if null, returns null

Returns:

may be null

attributeValueGet

public String attributeValueGet(String someAttrName)

Returns the value of attribute someAttrName.

Parameters:

someAttrName - if null, returns null

Returns:

may be null

position

public int position()

Returns the position of this element relative to its parent where the first position is 1.

Returns:

this element's position

attributeValueSet

public void attributeValueSet(String someAttrName,
                              String someValue)

Sets this element's someAttrName attribute to value someValue.

Parameters:

someAttrName - if null, no action is taken

someValue - if null, no action is taken

childElements

public List childElements()

Returns this element's child elements.

Invocation Context:

READ

Returns:

Collections.EMPTY_LIST or a list of XDSElement and NonXDSElement objects; will not return null