org.fao.geonet.csw.common.requests
Class GetRecordsRequest

java.lang.Object
  extended by org.fao.geonet.csw.common.requests.CatalogRequest
      extended by org.fao.geonet.csw.common.requests.GetRecordsRequest

public class GetRecordsRequest
extends CatalogRequest

Params: - resultType (0..1) Can be 'hits', 'results', 'validate'. Default is 'hits' - outputFormat (0..1) Can be only 'application/xml' - namespace (0..1) Used for the GET request - outputSchema (0..1) Can be 'ogccore', 'profile'. Default is 'ogccore' - startPosition (0..1) Default is 1 - maxRecords (0..1) Default is 10 - TypeNames (1..1) A set of 'dataset', 'datasetcollection', 'service', 'application' - elementSetName (0..1) Can be 'brief', 'summary', 'full'. Default is 'summary' - constraintLanguage (1..1) Can be 'CQL_TEXT', 'FILTER'. Must be included when 'constraint' is specified - constraintLanguageVersion (1..1) Example '1.0.0' - constraint (0..1) Query to execute - distributedSearch (0..1) TRUE|FALSE - hopCount (0..1) default is 2


Nested Class Summary
 
Nested classes/interfaces inherited from class org.fao.geonet.csw.common.requests.CatalogRequest
CatalogRequest.Method
 
Constructor Summary
GetRecordsRequest()
           
 
Method Summary
 void addSortBy(java.lang.String field, boolean ascend)
           
 void addTypeName(Csw.TypeName typeName)
           
protected  org.jdom.Element getPostParams()
           
protected  java.lang.String getRequestName()
           
 void setConstraint(java.lang.String constr)
           
 void setConstraintLanguage(Csw.ConstraintLanguage lang)
           
 void setConstraintLangVersion(java.lang.String version)
           
 void setDistributedSearch(boolean yesno)
           
 void setElementSetName(Csw.ElementSetName name)
           
 void setHopCount(java.lang.String count)
           
 void setMaxRecords(java.lang.String num)
           
 void setOutputFormat(java.lang.String format)
           
 void setOutputSchema(Csw.OutputSchema schema)
           
 void setResultType(Csw.ResultType type)
           
 void setStartPosition(java.lang.String start)
           
protected  void setupGetParams()
           
 
Methods inherited from class org.fao.geonet.csw.common.requests.CatalogRequest
addParam, addParam, addParam, execute, fill, fill, fill, fill, getAddress, getHost, getMethod, getPort, getReceivedData, getSentData, login, setAddress, setAttrib, setAttrib, setAttrib, setCredentials, setHost, setLoginAddress, setMethod, setPort, setUrl, setUseSOAP
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GetRecordsRequest

public GetRecordsRequest()
Method Detail

setResultType

public void setResultType(Csw.ResultType type)

setOutputFormat

public void setOutputFormat(java.lang.String format)

setOutputSchema

public void setOutputSchema(Csw.OutputSchema schema)

setStartPosition

public void setStartPosition(java.lang.String start)

setMaxRecords

public void setMaxRecords(java.lang.String num)

setElementSetName

public void setElementSetName(Csw.ElementSetName name)

addTypeName

public void addTypeName(Csw.TypeName typeName)

setConstraintLanguage

public void setConstraintLanguage(Csw.ConstraintLanguage lang)

setConstraintLangVersion

public void setConstraintLangVersion(java.lang.String version)

setConstraint

public void setConstraint(java.lang.String constr)

setDistributedSearch

public void setDistributedSearch(boolean yesno)

setHopCount

public void setHopCount(java.lang.String count)

addSortBy

public void addSortBy(java.lang.String field,
                      boolean ascend)

getRequestName

protected java.lang.String getRequestName()
Specified by:
getRequestName in class CatalogRequest

setupGetParams

protected void setupGetParams()
Specified by:
setupGetParams in class CatalogRequest

getPostParams

protected org.jdom.Element getPostParams()
Specified by:
getPostParams in class CatalogRequest