com.esri.aims.mtier.model.metadata.query
Class Clause

java.lang.Object
  |
  +--com.esri.aims.mtier.model.metadata.query.Clause

public class Clause
extends Object

Defines a metadata query clause. These clauses can then be embedded to result in complex queries.


Field Summary
static int AND_OPERATOR
           
static int CONTENTTYPE_SORT
           
static int DOCUMENT
           
static int GLOBALAREA_SORT
           
static int LOCALAREA_SORT
           
static int NAME_SORT
           
static int NONE
           
static int OR_OPERATOR
           
static int RELEVANCE_SORT
           
static int SEARCH
           
static int XOR_OPERATOR
           
 
Constructor Summary
Clause()
          Constructs an instance of a Clause object.
 
Method Summary
 DatasetCollection execute(ConnectionProxy connection)
          Executes the query and returns the results as a DatasetCollection.
 ClauseCollection getClauseCollection()
          Returns the ClauseCollection associated with this Clause.
 com.esri.w3c.dom.Element getClauseElement()
          Returns this object as an Element for building XML documents.
 DocumentInfoCollection getDocumentInfoCollection()
          Returns the DocumentInfoCollection for this Clause.
 EnvelopeCollection getEnvelopeCollection()
          Returns the EnvelopeCollection associated with this Clause.
 int getFolderMask()
          Returns the folder mask.
 boolean getFullOutput()
          Returns the fulloutput
 int getGndextent()
          Returns the constant that defines the gndextent.
 String getGndextentString()
          Returns the string value of the gndextent.
 int getMaxResults()
          Returns the maximum number of results that can be returned by the server.
 int getOperator()
          Returns the operator for this Clause.
 String getOperatorString()
          Returns the string value of the operator type.
 int getSort()
          Returns the constant that defines the sort type before batching.
 int getSort2()
          Returns the constant that defines the sort type after batching.
 String getSort2String()
          Returns the string value of the sort type used after batching.
 String getSortString()
          Returns the String value of the sort type used before batching.
 int getStartResults()
          Returns the start results as an integer value.
 SubsetCollection getSubsetCollection()
          Returns the SubsetCollection for this Clause.
 TextQueryCollection getTextQueryCollection()
          Returns the TextQueryCollection for this Clause.
 String getUpdatedAfter()
          Returns the updated after value.
 String getUpdatedBefore()
          Returns the updated before value.
 ValueQueryCollection getValueQueryCollection()
          Returns the VvalueQueryCollection for this Clause.
 void setClauseCollection(ClauseCollection newClauseCollection)
          Sets the given ClauseCollection for this Clause.
 void setDocumentInfoCollection(DocumentInfoCollection newDocumentInfoCollection)
          Sets the DocumentInfoCollection for this Clause.
 void setEnvelopeCollection(EnvelopeCollection newEnvelopeCollection)
          Sets the EnvelopeCollection for this Clause.
 void setFolderMask(int newFolderMask)
          Sets the folder mask.
 void setFullOutput(boolean fulloutput)
          Sets the fulloutput
 void setGndextent(int gndextentValue)
          Sets the gndextent
 void setMaxResults(int newMaxResults)
          Sets the maximum number of results returned by the server.
 void setOperator(int newOperator)
          Sets the operator for this Clause.
 void setSort(int sortValue)
          Set the sort type used to sort the results before batching.
 void setSort2(int sortValue)
          Sets the sort type used to sort the results after batching.
 void setStartResults(int newStartResults)
          Sets the start results.
 void setSubsetCollection(SubsetCollection newSubsetCollection)
          Sets the SubsetCollection for this Clause.
 void setTextQueryCollection(TextQueryCollection newTextQueryCollection)
          Sets the given TextQueryCollection for this Clause.
 void setUpdatedAfter(String updated)
          Sets the updated after value.
 void setUpdatedBefore(String updated)
          Sets the updated before value.
 void setValueQueryCollection(ValueQueryCollection newValueQueryCollection)
          Sets the ValueQueryCollection for this Clause.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

AND_OPERATOR

public static final int AND_OPERATOR
See Also:
Constant Field Values

OR_OPERATOR

public static final int OR_OPERATOR
See Also:
Constant Field Values

XOR_OPERATOR

public static final int XOR_OPERATOR
See Also:
Constant Field Values

NAME_SORT

public static final int NAME_SORT
See Also:
Constant Field Values

RELEVANCE_SORT

public static final int RELEVANCE_SORT
See Also:
Constant Field Values

CONTENTTYPE_SORT

public static final int CONTENTTYPE_SORT
See Also:
Constant Field Values

LOCALAREA_SORT

public static final int LOCALAREA_SORT
See Also:
Constant Field Values

GLOBALAREA_SORT

public static final int GLOBALAREA_SORT
See Also:
Constant Field Values

NONE

public static final int NONE
See Also:
Constant Field Values

DOCUMENT

public static final int DOCUMENT
See Also:
Constant Field Values

SEARCH

public static final int SEARCH
See Also:
Constant Field Values
Constructor Detail

Clause

public Clause()
Constructs an instance of a Clause object.

Method Detail

setEnvelopeCollection

public void setEnvelopeCollection(EnvelopeCollection newEnvelopeCollection)
Sets the EnvelopeCollection for this Clause.


getEnvelopeCollection

public EnvelopeCollection getEnvelopeCollection()
Returns the EnvelopeCollection associated with this Clause.


setClauseCollection

public void setClauseCollection(ClauseCollection newClauseCollection)
Sets the given ClauseCollection for this Clause.


getClauseCollection

public ClauseCollection getClauseCollection()
Returns the ClauseCollection associated with this Clause.


setTextQueryCollection

public void setTextQueryCollection(TextQueryCollection newTextQueryCollection)
Sets the given TextQueryCollection for this Clause.


getTextQueryCollection

public TextQueryCollection getTextQueryCollection()
Returns the TextQueryCollection for this Clause.


setValueQueryCollection

public void setValueQueryCollection(ValueQueryCollection newValueQueryCollection)
Sets the ValueQueryCollection for this Clause.


getValueQueryCollection

public ValueQueryCollection getValueQueryCollection()
Returns the VvalueQueryCollection for this Clause.


setSubsetCollection

public void setSubsetCollection(SubsetCollection newSubsetCollection)
Sets the SubsetCollection for this Clause.


getSubsetCollection

public SubsetCollection getSubsetCollection()
Returns the SubsetCollection for this Clause.


setDocumentInfoCollection

public void setDocumentInfoCollection(DocumentInfoCollection newDocumentInfoCollection)
Sets the DocumentInfoCollection for this Clause.


getDocumentInfoCollection

public DocumentInfoCollection getDocumentInfoCollection()
Returns the DocumentInfoCollection for this Clause.


setMaxResults

public void setMaxResults(int newMaxResults)
Sets the maximum number of results returned by the server.


getMaxResults

public int getMaxResults()
Returns the maximum number of results that can be returned by the server.


setStartResults

public void setStartResults(int newStartResults)
Sets the start results.


getStartResults

public int getStartResults()
Returns the start results as an integer value.


setFolderMask

public void setFolderMask(int newFolderMask)
Sets the folder mask.


getFolderMask

public int getFolderMask()
Returns the folder mask.


setOperator

public void setOperator(int newOperator)
Sets the operator for this Clause.


getOperator

public int getOperator()
Returns the operator for this Clause.


getOperatorString

public String getOperatorString()
Returns the string value of the operator type.


setSort

public void setSort(int sortValue)
Set the sort type used to sort the results before batching.

Parameters:
sortValue -

getSort

public int getSort()
Returns the constant that defines the sort type before batching.

Returns:
the sort type as an integer

getSortString

public String getSortString()
Returns the String value of the sort type used before batching.


setGndextent

public void setGndextent(int gndextentValue)
Sets the gndextent

Parameters:
gndextentValue -

getGndextent

public int getGndextent()
Returns the constant that defines the gndextent.

Returns:
an integer

getGndextentString

public String getGndextentString()
Returns the string value of the gndextent.

Returns:
String

setFullOutput

public void setFullOutput(boolean fulloutput)
Sets the fulloutput

Parameters:
fulloutput -

getFullOutput

public boolean getFullOutput()
Returns the fulloutput

Returns:
an boolean

setSort2

public void setSort2(int sortValue)
Sets the sort type used to sort the results after batching.

Parameters:
sortValue -

getSort2

public int getSort2()
Returns the constant that defines the sort type after batching.

Returns:
an integer

getSort2String

public String getSort2String()
Returns the string value of the sort type used after batching.


setUpdatedAfter

public void setUpdatedAfter(String updated)
Sets the updated after value.


getUpdatedAfter

public String getUpdatedAfter()
Returns the updated after value.


setUpdatedBefore

public void setUpdatedBefore(String updated)
Sets the updated before value.


getUpdatedBefore

public String getUpdatedBefore()
Returns the updated before value.


getClauseElement

public com.esri.w3c.dom.Element getClauseElement()
                                          throws AXLAttributeException
Returns this object as an Element for building XML documents.

AXLAttributeException

execute

public DatasetCollection execute(ConnectionProxy connection)
                          throws AXLAttributeException,
                                 ConnectionParameterException,
                                 UnableToPingEsrimapException,
                                 AuthenticationException,
                                 com.esri.xml.sax.SAXException,
                                 IOException
Executes the query and returns the results as a DatasetCollection.

AXLAttributeException
ConnectionParameterException
UnableToPingEsrimapException
AuthenticationException
com.esri.xml.sax.SAXException
IOException