|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.novell.nds.dirxml.driver.xds.ElementImpl
com.novell.nds.dirxml.driver.xds.XDSQueryElement
A <query>
element.
XDSCommandDocument
,
XDSQueryDocument
Field Summary | |
static Integer |
UNLIMITED_RESULTS
|
Method Summary | |
XDSAssociationElement |
appendAssociationElement(String value)
Appends a child <association> element to this
element. |
XDSReadAttrElement |
appendReadAttrElement()
Appends an empty child <read-attr> element to this
element. |
XDSReadParentElement |
appendReadParentElement()
Appends an empty, child <read-parent> element to this
element. |
XDSSearchAttrElement |
appendSearchAttrElement()
Appends an empty child <search-attr> element to this
element. |
XDSSearchClassElement |
appendSearchClassElement()
Appends an empty child <search-class> element to this
element. |
List |
childElements()
Returns this element's child elements. |
boolean |
containsQueryToken()
Always returns false since a standard query cannot contain
a query token. |
boolean |
containsReadAttrElements()
Does this query contain <read-attr> elements?
|
boolean |
containsSearchAttrElements()
Does this query contain search-attr elements?
|
boolean |
containsSearchClassElements()
Does this query contain search-class 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. |
XDSQueryTokenElement |
extractQueryToken()
Always returns null since a standard query does not contain
a query token. |
String |
extractQueryTokenText()
Always returns null since a standard query does not contain
a query token. |
List |
extractReadAttrElements()
Returns this element's child <read-attr> elements. |
XDSReadParentElement |
extractReadParentElement()
Returns this element's child <read-parent> element. |
List |
extractSearchAttrElements()
Returns this element's child <search-attr> elements. |
List |
extractSearchClassElements()
Returns this element's child <search-class> elements. |
String |
getClassName()
Gets the value of this element's class-name attribute. |
String |
getDestDN()
Gets the value of this element's dest-dn attribute. |
String |
getEventID()
Gets the value of this element's event-id attribute. |
int |
getMaxResultCount()
How may results should be returned for this query? |
String |
getQualifiedSrcDN()
A method stub for implementing interface CommandElement . |
QueryScope |
getScope()
Gets the value of this element's scope attribute. |
String |
getSrcDN()
A method stub for implementing interface CommandElement . |
String |
getSrcEntryID()
A method stub for implementing interface CommandElement . |
boolean |
hasEntryScope()
Does this query have entry scope? |
boolean |
hasLimitedResults()
Always returns false since a standard query's result set is
unlimited in size. |
boolean |
hasRootBaseObject()
Is the base object of this query the root object in a heirarchical name space or all objects in a flat name space? |
boolean |
hasSubordinatesScope()
Does this query have subordinates scope? |
boolean |
hasSubtreeScope()
Does this query have subtree scope? |
boolean |
hasUnlimitedResults()
Always returns true since a standard query's result set is
unlimited in size. |
boolean |
isCancelled()
Always returns false since a standard query can't be
cancelled. |
boolean |
isExtended()
Does this query require special result set handling? |
boolean |
isIdentity()
Is this query an identity query? |
boolean |
isInitialQuery()
Always returns true since a standard query is always the
first and last query in a sequence. |
boolean |
isSubsequentQuery()
Always returns false since a standard query is the first
and last query in a sequence. |
void |
setClassName(String someName)
Sets this element's class-name attribute to
someName . |
void |
setDestDN(String someDN)
Sets this element's dest-dn attribute to
someDN . |
void |
setDestEntryID(String someID)
Sets this element's dest-entry-id attribute to
someID . |
void |
setEventID(String someID)
Sets this element's event-id attribute to
someID . |
void |
setScope(QueryScope someScope)
Sets this element's scope attribute to
someScope . |
boolean |
shouldReadAttributes()
Should a driver return attribute information for objects that match this queries search criteria? |
boolean |
shouldReadParent()
Should a driver return parent object information for objects that match this queries search criteria? |
boolean |
shouldSearchAllClasses()
Should a driver search all application classes? |
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 |
Field Detail |
public static final Integer UNLIMITED_RESULTS
Method Detail |
public String getSrcDN()
CommandElement
.
getSrcDN
in interface CommandElement
null
; will not return
""
public String getQualifiedSrcDN()
CommandElement
.
getQualifiedSrcDN
in interface CommandElement
null
; will not return
""
public String getSrcEntryID()
CommandElement
.
getSrcEntryID
in interface CommandElement
null
; will not return
""
public QueryScope getScope()
scope
attribute.
null
public boolean isIdentity()
An identity query is used to identify a driver to the DirXML engine. A
query is considered an identity query if either it has an
event-id
attribute value of
"query-driver-ident"
or it contains a
<search-class>
element with a
class-name
attribute value of
"__driver_identification_class__"
.
true
:false
:public boolean hasEntryScope()
true
:scope
attribute value equals
"entry"
false
:scope
attribute value does not equals
"entry"
public boolean hasSubordinatesScope()
true
:scope
attribute value equals
"subordinates"
false
:scope
attribute value does not
equals "subordinates"
public boolean hasSubtreeScope()
true
:scope
attribute value equals
"subtree"
or ""
false
:scope
attribute value does not equal
"subtree"
or ""
public List childElements()
childElements
in interface XDSElement
childElements
in class ElementImpl
Collections.EMPTY_LIST
or a list of
XDSAssociationElement
,
XDSSearchClassElement
,
XDSSearchAttrElement
,
XDSReadAttrElement
,
XDSReadParentElement
, and
NonXDSElement
objects; will not return
null
public XDSAssociationElement extractAssociationElement()
<association>
element.
extractAssociationElement
in interface AssociationElementParent
null
public String extractAssociationText()
<association>
element.
extractAssociationText
in interface AssociationElementParent
null
; will not return ""
public String getClassName()
class-name
attribute.
This value should not be used to limit the scope of classes searched.
getClassName
in interface CommandElement
null
; will not return ""
extractSearchClassElements()
public String getDestDN()
dest-dn
attribute.
null
; will not return ""
public String getEventID()
CommandElement
event-id
attribute.
getEventID
in interface CommandElement
null
; will not return ""
public boolean shouldSearchAllClasses()
true
:false
:public boolean shouldReadAttributes()
true
:false
:public boolean hasRootBaseObject()
The base object of a query is specified by either the
dest-dn
attribute or child
<association>
element. If neither are present, the
base object defaults to the root object in a hierarchical name space or
all ojects in a non-hierarchical name space.
true
:false
:public boolean containsSearchAttrElements()
search-attr
elements?
true
if this query contains
search-attr
elements, false
otherwisepublic boolean containsReadAttrElements()
<read-attr>
elements?
NOTE: returns false
if this query contains a
<read-attr>
element without an
attr-name
attribute value
true
if this query contains read-attr
elements with attr-name
attribute values,
false
otherwisepublic boolean containsSearchClassElements()
search-class
elements?
true
if this query contains
search-class
elements, false
otherwisepublic List extractSearchClassElements()
<search-class>
elements.
java.util.Collections.EMPTY_LIST
or a list of
XDSSearchClassElement
objects; will not return
null
public List extractSearchAttrElements()
<search-attr>
elements.
java.util.Collections.EMPTY_LIST
or a list of
XDSSearchAttrElement
objects; will not return
null
public List extractReadAttrElements()
<read-attr>
elements.
NOTE: returns Collections.EMPTY_LIST
if this query contains
a <read-attr>
element without an
attr-name
attribute value
java.util.Collections.EMPTY_LIST
or a list of
XDSReadAttrElement
objects; will not return
null
public boolean shouldReadParent()
true
:false
:public XDSReadParentElement extractReadParentElement()
<read-parent>
element.
null
public int getMaxResultCount()
java.lang.Integer.MAX_VALUE
Integer.MAX_VALUE
public boolean containsQueryToken()
false
since a standard query cannot contain
a query token.
false
public XDSQueryTokenElement extractQueryToken()
null
since a standard query does not contain
a query token.
null
public String extractQueryTokenText()
null
since a standard query does not contain
a query token.
null
public boolean hasUnlimitedResults()
true
since a standard query's result set is
unlimited in size.
true
public boolean hasLimitedResults()
false
since a standard query's result set is
unlimited in size.
false
public boolean isCancelled()
false
since a standard query can't be
cancelled.
false
public boolean isExtended()
This method always returns false
since a standard query is,
by definition, not an extended query (that is, cannot limit the size of
a result set).
false
public boolean isInitialQuery()
true
since a standard query is always the
first and last query in a sequence.
false
public boolean isSubsequentQuery()
false
since a standard query is the first
and last query in a sequence.
false
public void setDestDN(String someDN)
dest-dn
attribute to
someDN
.
someDN
- if null
or ""
, no action is
takenpublic void setClassName(String someName)
class-name
attribute to
someName
.
someName
- if null
or ""
, no action is
takenpublic void setEventID(String someID)
CommandElement
event-id
attribute to
someID
.
setEventID
in interface CommandElement
someID
- if null
or ""
, no action is
takenpublic void setDestEntryID(String someID)
dest-entry-id
attribute to
someID
.
someID
- if null
or ""
, no action is
takenpublic void setScope(QueryScope someScope)
scope
attribute to
someScope
.
someScope
- if null
, no action is takenpublic XDSAssociationElement appendAssociationElement(String value)
AssociationElementParent
<association>
element to this
element. The <association>
element contains the text
someText
.
appendAssociationElement
in interface AssociationElementParent
value
- the association value; if null
or
""
, an empty, child
<association>
element is appended
null
public XDSSearchClassElement appendSearchClassElement()
<search-class>
element to this
element.
null
public XDSSearchAttrElement appendSearchAttrElement()
<search-attr>
element to this
element.
null
public XDSReadAttrElement appendReadAttrElement()
<read-attr>
element to this
element.
null
public XDSReadParentElement appendReadParentElement()
<read-parent>
element to this
element. When called multiple times, no action is taken and the first
<read-parent>
element is returned.
null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |