com.esri.gpt.server.csw.provider.components
Class QueryOptions

java.lang.Object
  com.esri.gpt.server.csw.provider.components.QueryOptions

public class QueryOptions
extends Object

Options associated with a CSW query request.

Applies to the GetRecordById and GetRecords operations.

Constructor Summary

QueryOptions()
Default constructor

Method Summary

StringSet	getElementNames() Gets the requested response element names (specific returnables).
String	getElementSetType() Gets the response element set type (brief,summary,full).
StringSet	getElementSetTypeNames() Gets the type names specified for the element set type.
StringSet	getIDs() Gets the requested IDs.
int	getMaxRecords() Gets the maximum number of records to return.
int	getMaxRecordsThreshold() Gets the threshold for the maximum number of record to return.
String	getOutputSchema() Gets the requested output XML schema.
String	getQueryConstraintCql() Gets the query constraint CQL text.
String	getQueryConstraintVersion() Gets the query constraint version.
StringSet	getQueryTypeNames() Gets the type names specified for the query.
String	getResultType() Gets the query result type (hits,results,validate).
String	getSchemaFilter() Gets the schema name query filter.
int	getStartRecord() Gets the starting record.
boolean	isDublinCoreResponse() Determines if the response is Dublin Core based.
void	setElementNames(StringSet elementNames) Sets the requested response element names (specific returnables).
void	setElementSetType(String elementSetType) Sets the response element set type (brief,summary,full).
void	setElementSetTypeNames(StringSet elementSetTypeNames) Sets the type names specified for the element set type.
void	setIDs(StringSet ids) Sets the requested IDs.
void	setMaxRecords(int maxRecords) Sets the maximum number of records to return.
void	setMaxRecordsThreshold(int maxRecordsThreshold) Sets the threshold for the maximum number of record to return.
void	setOutputSchema(String outputSchema) Sets the requested output XML schema.
void	setQueryConstraintCql(String cql) Sets the query constraint CQL text.
void	setQueryConstraintVersion(String version) Sets the query constraint version
void	setQueryTypeNames(StringSet queryTypeNames) Sets the type names specified for the query.
void	setResultType(String resultType) Sets the query result type (hits,results,validate).
void	setStartRecord(int startRecord) Sets the starting record.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryOptions

public QueryOptions()

Default constructor

Method Detail

getElementNames

public StringSet getElementNames()

Gets the requested response element names (specific returnables).

Returns:

the element names

setElementNames

public void setElementNames(StringSet elementNames)

Sets the requested response element names (specific returnables).

Parameters:

elementNames - the element names

getElementSetType

public String getElementSetType()

Gets the response element set type (brief,summary,full).

Returns:

the element set type

setElementSetType

public void setElementSetType(String elementSetType)

Sets the response element set type (brief,summary,full).

Parameters:

elementSetType - the element set type

getElementSetTypeNames

public StringSet getElementSetTypeNames()

Gets the type names specified for the element set type.

Returns:

the element set type names

setElementSetTypeNames

public void setElementSetTypeNames(StringSet elementSetTypeNames)

Sets the type names specified for the element set type.

Parameters:

elementSetTypeNames - the element set type names

getIDs

public StringSet getIDs()

Gets the requested IDs.

Returns:

the IDs

setIDs

public void setIDs(StringSet ids)

Sets the requested IDs.

Parameters:

ids - the IDs

getMaxRecords

public int getMaxRecords()

Gets the maximum number of records to return.
Default = 10.

Returns:

the maximum number of records to return

setMaxRecords

public void setMaxRecords(int maxRecords)

Sets the maximum number of records to return.
A value of zero or less will return no records (hit count only).
If the supplied value exceeds the threshold, the max records will be set to the threshold.

Parameters:

maxRecords - maximum number of records to return

getMaxRecordsThreshold

public int getMaxRecordsThreshold()

Gets the threshold for the maximum number of record to return.
Default = 5000.

Returns:

the maximum number of records threshhold

setMaxRecordsThreshold

public void setMaxRecordsThreshold(int maxRecordsThreshold)

Sets the threshold for the maximum number of record to return.

Parameters:

maxRecordsThreshold - the maximum number of records threshhold

getOutputSchema

public String getOutputSchema()

Gets the requested output XML schema.

Returns:

the output schema (can be null)

setOutputSchema

public void setOutputSchema(String outputSchema)

Sets the requested output XML schema.

Parameters:

outputSchema - the output schema

getQueryConstraintCql

public String getQueryConstraintCql()

Gets the query constraint CQL text.

Returns:

the query constraint CQL

setQueryConstraintCql

public void setQueryConstraintCql(String cql)

Sets the query constraint CQL text.

Parameters:

cql - the query constraint CQL

getQueryConstraintVersion

public String getQueryConstraintVersion()

Gets the query constraint version.

Returns:

the query constraint version

setQueryConstraintVersion

public void setQueryConstraintVersion(String version)

Sets the query constraint version

Parameters:

version - the query constraint version

getQueryTypeNames

public StringSet getQueryTypeNames()

Gets the type names specified for the query.

Returns:

the query type names

setQueryTypeNames

public void setQueryTypeNames(StringSet queryTypeNames)

Sets the type names specified for the query.

Parameters:

queryTypeNames - the query type names

getResultType

public String getResultType()

Gets the query result type (hits,results,validate).

Returns:

the result type

setResultType

public void setResultType(String resultType)

Sets the query result type (hits,results,validate).

Parameters:

resultType - the result type

getSchemaFilter

public String getSchemaFilter()

Gets the schema name query filter.
Only applies to non Dublin Core responses.

Returns:

the schema name query filter

getStartRecord

public int getStartRecord()

Gets the starting record.

Returns:

the starting record

setStartRecord

public void setStartRecord(int startRecord)

Sets the starting record.
If the supplied value is less that 1, the start record will be set to 1.

Parameters:

startRecord - the starting record

isDublinCoreResponse

public boolean isDublinCoreResponse()

Determines if the response is Dublin Core based.

Returns:

true if the response is Dublin Core