org.deegree_impl.services.wcas.protocol
Class CASGetRecordRequest_Impl

java.lang.Object
  org.deegree_impl.services.OGCWebServiceRequest_Impl
      org.deegree_impl.services.wcas.protocol.CASGetRecordRequest_Impl

All Implemented Interfaces:

CASGetRecordRequest, OGCWebServiceRequest

public final class CASGetRecordRequest_Impl

extends OGCWebServiceRequest_Impl

implements CASGetRecordRequest

A query request against a catalog service is described using the >GetRecord< element. The getRecord request bases on the request specified at the "OGC Web Services Stateless Catalog Profile" and is enhanced by some parameters defined within the GDI NRW Testbed II.

--------------------------------------------------------------------

Version:

$Revision: 1.4 $ $Date: 2004/03/29 10:39:04 $

Author:

Andreas Poth

Field Summary

private Filter	filter
private int	maxRecords
private java.lang.String	outputFormat
private java.lang.String	outputRecType
private java.util.ArrayList	queries
private int	queryScope
private int	startPosition

Fields inherited from class org.deegree_impl.services.OGCWebServiceRequest_Impl

id, request, service, vendorSpecificParameter, version

Constructor Summary

(package private)

CASGetRecordRequest_Impl(java.lang.String version, java.lang.String id, java.util.HashMap vendorSpecificParameter, int maxRecords, int startPosition, java.lang.String outputFormat, java.lang.String outputRecType, CASQuery[] queries, int queryScope, Filter filter) Creates a new CASGetRecordRequest_Impl object.

Method Summary

void	addQuery(CASQuery query)
Filter	getFilter() returns a Filter object that is common to all queries definied in a getRecord request
int	getMaxRecords() returns the maximum amount of records that shall be returned as result of a getRecord request. if getMaxRecords returns a value that is larger than the maxRecords defined in the capabilities of the service the last one will be used.
java.lang.String	getOutputFormat() returns the name of the format the result of the request have to be formatted (default = XML)
java.lang.String	getOutputRecType() returns the record type the result shall be formated in. a catalog may offers different metadata formats for different kind of metadata (service- versus data-metadata) or different formats for the same kind of metadata (e.g. different profils on ISO19115).
CASQuery[]	getQuery() returns the query objects of the getRecord request that specifies the query in detail
int	getQueryScope() returns a number that indicates if the request is part of a cascading request
int	getStartPosition() returns the position (e.g. row of a table) where to start the query.
void	setFilter(Filter filter)
void	setMaxRecords(int maxRecords)
void	setOutputFormat(java.lang.String outputFormat)
void	setOutputRecType(java.lang.String outputRecType)
void	setQuery(CASQuery[] queries)
void	setQueryScope(int queryScope)
void	setStartPosition(int startPosition)
java.lang.String	toString()

Methods inherited from class org.deegree_impl.services.OGCWebServiceRequest_Impl

getId, getRequest, getRequestParameter, getService, getVendorSpecificParameter, getVendorSpecificParameters, getVersion, putVendorSpecificParameter, setId, setRequest, setService, setVendorSpecificParameter, setVersion

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.deegree.services.OGCWebServiceRequest

getId, getRequest, getRequestParameter, getService, getVendorSpecificParameter, getVendorSpecificParameters, getVersion

Field Detail

queries

private java.util.ArrayList queries

filter

private Filter filter

outputFormat

private java.lang.String outputFormat

outputRecType

private java.lang.String outputRecType

maxRecords

private int maxRecords

queryScope

private int queryScope

startPosition

private int startPosition

Constructor Detail

CASGetRecordRequest_Impl

CASGetRecordRequest_Impl(java.lang.String version,
                         java.lang.String id,
                         java.util.HashMap vendorSpecificParameter,
                         int maxRecords,
                         int startPosition,
                         java.lang.String outputFormat,
                         java.lang.String outputRecType,
                         CASQuery[] queries,
                         int queryScope,
                         Filter filter)

Creates a new CASGetRecordRequest_Impl object.

Parameters:

version -

id -

vendorSpecificParameter -

maxRecords -

startPosition -

outputFormat -

outputRecType -

queries -

queryScope -

filter -

Method Detail

getQuery

public CASQuery[] getQuery()

returns the query objects of the getRecord request that specifies the query in detail

Specified by:

getQuery in interface CASGetRecordRequest

setQuery

public void setQuery(CASQuery[] queries)

See Also:

getQuery()

addQuery

public void addQuery(CASQuery query)

See Also:

getQuery()

getFilter

public Filter getFilter()

returns a Filter object that is common to all queries definied in a getRecord request

Specified by:

getFilter in interface CASGetRecordRequest

setFilter

public void setFilter(Filter filter)

Parameters:

filter -

getMaxRecords

public int getMaxRecords()

returns the maximum amount of records that shall be returned as result of a getRecord request. if getMaxRecords returns a value that is larger than the maxRecords defined in the capabilities of the service the last one will be used.

Specified by:

getMaxRecords in interface CASGetRecordRequest

setMaxRecords

public void setMaxRecords(int maxRecords)

See Also:

getMaxRecords()

getStartPosition

public int getStartPosition()

returns the position (e.g. row of a table) where to start the query. this is a usefull parameter if you like to retrieve the result of a query in block of e.g. 20 entries.

Specified by:

getStartPosition in interface CASGetRecordRequest

setStartPosition

public void setStartPosition(int startPosition)

See Also:

getStartPosition()

getQueryScope

public int getQueryScope()

returns a number that indicates if the request is part of a cascading request

Specified by:

getQueryScope in interface CASGetRecordRequest

setQueryScope

public void setQueryScope(int queryScope)

Specified by:

setQueryScope in interface CASGetRecordRequest

See Also:

because the queryScope changes (it is lowered) if the request is forced to the the next server at the cascade it have to be changable.

getOutputFormat

public java.lang.String getOutputFormat()

returns the name of the format the result of the request have to be formatted (default = XML)

Specified by:

getOutputFormat in interface CASGetRecordRequest

setOutputFormat

public void setOutputFormat(java.lang.String outputFormat)

See Also:

getOutputFormat()

getOutputRecType

public java.lang.String getOutputRecType()

returns the record type the result shall be formated in. a catalog may offers different metadata formats for different kind of metadata (service- versus data-metadata) or different formats for the same kind of metadata (e.g. different profils on ISO19115).

Specified by:

getOutputRecType in interface CASGetRecordRequest

setOutputRecType

public void setOutputRecType(java.lang.String outputRecType)

See Also:

getOutputRecType()

toString

public java.lang.String toString()

Overrides:

toString in class OGCWebServiceRequest_Impl

Returns: