|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.esri.aims.mtier.model.metadata.query.Clause
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 |
public static final int AND_OPERATOR
public static final int OR_OPERATOR
public static final int XOR_OPERATOR
public static final int NAME_SORT
public static final int RELEVANCE_SORT
public static final int CONTENTTYPE_SORT
public static final int LOCALAREA_SORT
public static final int GLOBALAREA_SORT
public static final int NONE
public static final int DOCUMENT
public static final int SEARCH
Constructor Detail |
public Clause()
Method Detail |
public void setEnvelopeCollection(EnvelopeCollection newEnvelopeCollection)
public EnvelopeCollection getEnvelopeCollection()
public void setClauseCollection(ClauseCollection newClauseCollection)
public ClauseCollection getClauseCollection()
public void setTextQueryCollection(TextQueryCollection newTextQueryCollection)
public TextQueryCollection getTextQueryCollection()
public void setValueQueryCollection(ValueQueryCollection newValueQueryCollection)
public ValueQueryCollection getValueQueryCollection()
public void setSubsetCollection(SubsetCollection newSubsetCollection)
public SubsetCollection getSubsetCollection()
public void setDocumentInfoCollection(DocumentInfoCollection newDocumentInfoCollection)
public DocumentInfoCollection getDocumentInfoCollection()
public void setMaxResults(int newMaxResults)
public int getMaxResults()
public void setStartResults(int newStartResults)
public int getStartResults()
public void setFolderMask(int newFolderMask)
public int getFolderMask()
public void setOperator(int newOperator)
public int getOperator()
public String getOperatorString()
public void setSort(int sortValue)
sortValue
- public int getSort()
public String getSortString()
public void setGndextent(int gndextentValue)
gndextentValue
- public int getGndextent()
public String getGndextentString()
public void setFullOutput(boolean fulloutput)
fulloutput
- public boolean getFullOutput()
public void setSort2(int sortValue)
sortValue
- public int getSort2()
public String getSort2String()
public void setUpdatedAfter(String updated)
public String getUpdatedAfter()
public void setUpdatedBefore(String updated)
public String getUpdatedBefore()
public com.esri.w3c.dom.Element getClauseElement() throws AXLAttributeException
AXLAttributeException
public DatasetCollection execute(ConnectionProxy connection) throws AXLAttributeException, ConnectionParameterException, UnableToPingEsrimapException, AuthenticationException, com.esri.xml.sax.SAXException, IOException
AXLAttributeException
ConnectionParameterException
UnableToPingEsrimapException
AuthenticationException
com.esri.xml.sax.SAXException
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |