|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.org.ogsadai.client.toolkit.activity.RequestComponent
uk.org.ogsadai.client.toolkit.activity.Activity
uk.org.ogsadai.client.toolkit.activity.xmldb.XMLListCollections
This activity lists the collections within an XML database collection as exposed by an XMLDB data service resource.
It has no input and one output - the collections in the database. The format of the output is OGSA-DAI-specific XML. For example:
<collectionNames count="3">
<name> someCollectionName </name>
<name> someOtherName </name>
<name> andAnotherName </name>
</collectionNames>
Field Summary | |
private static java.lang.String |
COPYRIGHT_NOTICE
Copyright statement |
private java.lang.String |
mCollectionName
Collection name |
Fields inherited from class uk.org.ogsadai.client.toolkit.activity.Activity |
|
Fields inherited from class uk.org.ogsadai.client.toolkit.activity.RequestComponent |
|
Constructor Summary | |
XMLListCollections()
Constructs a request to list collections of some collection. |
Method Summary | |
protected java.lang.String |
generateXML()
Generates the XML representing the activity. |
java.lang.String[] |
getCollectionNames()
Gets the list of collection names. |
ActivityOutput |
getOutput()
Gets the activity's only output - the list of names. |
void |
setCollectionName(java.lang.String collectionName)
Set the collection name. |
Methods inherited from class uk.org.ogsadai.client.toolkit.activity.Activity |
addInput, addOutput, addOutputs, getDataResourceID, getInputParameters, getOutputParameters, getOutputs, replaceSpecialCharacters, setDataResourceID, setInput |
Methods inherited from class uk.org.ogsadai.client.toolkit.activity.RequestComponent |
getDataService, getName, getSession, setDataService, setSession |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
private static final java.lang.String COPYRIGHT_NOTICE
private java.lang.String mCollectionName
Constructor Detail |
public XMLListCollections()
Method Detail |
public void setCollectionName(java.lang.String collectionName)
null
then the
sub-collections of the base collection will be listed.
collectionName
- The name of the collection or null
.public java.lang.String[] getCollectionNames() throws NoActivityOutputException, DataFormatException
NoActivityOutputException
- if there is no output data or the data has not yet been
processed to this output or the activity that generates
this output has not yet been executed.
DataFormatException
- if the output from the activity cannot be parsed into a
list of names.public ActivityOutput getOutput()
protected java.lang.String generateXML()
RequestComponent
generateXML
in class Activity
Activity.generateXML()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |