com.novell.nds.dirxml.driver.xds
Class XDSInstanceElement

java.lang.Object
  com.novell.nds.dirxml.driver.xds.ElementImpl
      com.novell.nds.dirxml.driver.xds.XDSInstanceElement

All Implemented Interfaces:

AssociationElementParent, XDSElement

public class XDSInstanceElement

extends ElementImpl

implements AssociationElementParent

An <instance> element.

See Also:

QueryResultDocument.appendInstanceElement(), QueryResultDocument.extractInstanceElements()

Method Summary

XDSAssociationElement	appendAssociationElement(String someText) Appends a child <association> element to this element.
XDSAttrElement	appendAttrElement() Appends an empty child <attr> element to this element.
XDSParentElement	appendParentElement() Appends an empty child <parent> element to this element.
List	childElements() Returns this element's child elements.
XDSAssociationElement	extractAssociationElement() Returns this element's child <association> element.
String	extractAssociationText() Returns the concatenated child text nodes from this element's child <association> element.
List	extractAttrElements() Returns this element's child attr elements.
XDSParentElement	extractParentElement() Returns this element's child <parent> element.
String	getClassName() Gets the value of this element's class-name attribute.
String	getEventID() Gets the value of this element's event-id attribute.
String	getQualifiedSrcDN() Gets the value of this element's qualified-src-dn attribute.
String	getSrcDN() Gets the value of this element's src-dn attribute.
void	setClassName(String someName) Sets this element's class-name attribute to someName.
void	setEventID(String someID) Sets this element's event-id attribute to someID.
void	setSrcDN(String someDN) Sets this element's src-dn attribute to someDN.

Methods inherited from class com.novell.nds.dirxml.driver.xds.ElementImpl

attributeValueGet, attributeValueGet, attributeValueSet, documentImpl, domDocument, domElement, localName, namespaceName, position, tagName

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.novell.nds.dirxml.driver.xds.XDSElement

attributeValueGet, attributeValueGet, attributeValueSet, domDocument, domElement, localName, namespaceName, position, tagName

Method Detail

getClassName

public String getClassName()

Gets the value of this element's class-name attribute.

Invocation Context:

READ

Returns:

will not return null; will not return ""

getSrcDN

public String getSrcDN()

Gets the value of this element's src-dn attribute.

Invocation Context:

READ

Returns:

may return null; will not return ""

getQualifiedSrcDN

public String getQualifiedSrcDN()

Gets the value of this element's qualified-src-dn attribute.

Invocation Context:

READ

Returns:

may return null; will not return ""

Since:

DTD 2.0

getEventID

public String getEventID()

Gets the value of this element's event-id attribute.

Invocation Context:

READ

Returns:

may be null; will not return ""

extractParentElement

public XDSParentElement extractParentElement()

Returns this element's child <parent> element.

Invocation Context:

READ

Returns:

may be null

childElements

public List childElements()

Returns this element's child elements.

Usage Notes:

The types of objects returned by this method may be extended in the future. Thus, callers should be able to handle object types other than those listed in the returns field below.

Invocation Context:

READ

Specified by:

childElements in interface XDSElement

Overrides:

childElements in class ElementImpl

Returns:

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

extractAttrElements

public List extractAttrElements()

Returns this element's child attr elements.

Invocation Context:

READ

Returns:

java.util.Collections.EMPTY_LIST or a list of XDSAttrElement objects; will not return null

extractAssociationElement

public XDSAssociationElement extractAssociationElement()

Description copied from interface: AssociationElementParent

Returns this element's child <association> element.

Invocation Context:

READ

Specified by:

extractAssociationElement in interface AssociationElementParent

Returns:

may return null

extractAssociationText

public String extractAssociationText()

Description copied from interface: AssociationElementParent

Returns the concatenated child text nodes from this element's child <association> element.

Invocation Context:

READ

Specified by:

extractAssociationText in interface AssociationElementParent

Returns:

may return null; will not return ""

setClassName

public void setClassName(String someName)

Sets this element's class-name attribute to someName.

Usage Notes:

The types of objects returned by this method may be extended in the future. Thus, callers should be able to handle object types other than those listed in the returns field below.

Invocation Context:

WRITE

Parameters:

someName - if null or "", no action is taken

setSrcDN

public void setSrcDN(String someDN)

Sets this element's src-dn attribute to someDN.

Invocation Context:

WRITE

Parameters:

someDN - if null or "", no action is taken

setEventID

public void setEventID(String someID)

Sets this element's event-id attribute to someID.

Invocation Context:

WRITE

Parameters:

someID - if null or "", no action is taken

appendAttrElement

public XDSAttrElement appendAttrElement()

Appends an empty child <attr> element to this element.

Invocation Context:

WRITE

Returns:

will not return null

appendParentElement

public XDSParentElement appendParentElement()

Appends an empty child <parent> element to this element.

Invocation Context:

WRITE

Returns:

will not return null

appendAssociationElement

public XDSAssociationElement appendAssociationElement(String someText)

Description copied from interface: AssociationElementParent

Appends a child <association> element to this element. The <association> element contains the text someText.

Invocation Context:

WRITE

Specified by:

appendAssociationElement in interface AssociationElementParent

Parameters:

someText - the association value; if null or "", an empty, child <association> element is appended

Returns:

will not return null