org.deegree.ogcwebservices.csw.capabilities
Class CatalogueOperationsMetadata
java.lang.Object
org.deegree.ogcwebservices.getcapabilities.OperationsMetadata
org.deegree.ogcwebservices.csw.capabilities.CatalogueOperationsMetadata
- All Implemented Interfaces:
- java.io.Serializable
public class CatalogueOperationsMetadata
- extends OperationsMetadata
Represents the OperationMetadata
part in the capabilities document of an OGC-CSW
according to the OpenGIS�
Catalogue Services Specification 2.0
.
In addition to the GetCapabilities
operation that all OWS 0.2
compliant services must implement, it may define some or all of the following operations:
Name |
Mandatory? |
Function |
DescribeRecord |
X |
Allows a client to discover elements of the information model supported by the target
catalogue service. |
GetDomain |
- |
The optional GetDomain operation is used to obtain runtime information about the range of
values of a metadata record element or request parameter. The runtime range of values for a
property or request parameter is typically much smaller than the value space for that property or
parameter based on its static type definition. For example, a property or request parameter
defined as a 16bit positive integer in a database may have a value space of 65535 distinct
integers but the actual number of distinct values existing in the database may be much smaller.
This type of runtime information about the range of values of a property or request parameter is
useful for generating user interfaces with meaningful pick lists or for generating query
predicates that have a higher chance of actually identifying a result set. It should be noted
that the GetDomain operation is a �best-effort� operation. That is to say that a catalogue tries
to generate useful information about the specified request parameter or property if it can. It is
entirely possible that a catalogue may not be able to determine anything about the values of a
property or request parameter in which case an empty response should be generated. |
GetRecords |
X |
The primary means of resource discovery in the general model are the two operations search
and present. In the HTTP protocol binding these are combined in the form of the mandatory
GetRecords operation, which does a search and a piggybacked present. |
GetRecordById |
X |
The mandatory GetRecordById request retrieves the default representation of catalogue
records using their identifier. The GetRecordById operation is an implementation of the Present
operation from the general model. This operation presumes that a previous query has been
performed in order to obtain the identifiers that may be used with this operation. For example,
records returned by a GetRecords operation may contain references to other records in the
catalogue that may be retrieved using the GetRecordById operation. This operation is also a
subset of the GetRecords operation, and is included as a convenient short form for retrieving and
linking to records in a catalogue. |
Transaction |
- |
The optional Transaction operation defines an interface for creating, modifying and deleting
catalogue records. The specific payload being manipulated must be defined in a profile. |
Harvest |
- |
The optional Harvest operation is an operation that "pulls" data into the catalogue. That
is, this operation only references the data to be inserted or updated in the catalogue, and it is
the job of the catalogue service to resolve the reference, fetch that data, and process it into
the catalogue. The Harvest operation has two modes of operation, controlled by a flag in the
request. The first mode of operation is a synchronous mode in which the CSW receives a Harvest
request from the client, processes it immediately, and sends the results to the client while the
client waits. The second mode of operation is asynchronous in that the server receives a Harvest
request from the client, and sends the client an immediate acknowledgement that the request has
been successfully received. The server can then process the Harvest request whenever it likes,
taking as much time as is required and then send the results of the processing to a URI specified
in the original Harvest request. This latter mode of operation is included to support Harvest
requests that could run for a period of time longer than most HTTP timeout's will allow.
Processing a Harvest request means that the CSW resolves the URI pointing to the metadata
resource, parses the resource, and then creates or modifies metadata records in the catalogue in
order to register the resource. This operation may be performed only once or periodically
depending on how the client invokes the operation. |
- Version:
- $Revision: 18195 $, $Date: 2009-06-18 17:55:39 +0200 (Do, 18 Jun 2009) $
- Author:
- Andreas Poth , last edited by: $Author: mschneider $
- See Also:
OperationsMetadata
,
Serialized Form
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
DESCRIBE_RECORD_NAME
public static final java.lang.String DESCRIBE_RECORD_NAME
- See Also:
- Constant Field Values
GET_DOMAIN_NAME
public static final java.lang.String GET_DOMAIN_NAME
- See Also:
- Constant Field Values
GET_RECORDS_NAME
public static final java.lang.String GET_RECORDS_NAME
- See Also:
- Constant Field Values
GET_RECORD_BY_ID_NAME
public static final java.lang.String GET_RECORD_BY_ID_NAME
- See Also:
- Constant Field Values
GET_REPOSITORY_ITEM
public static final java.lang.String GET_REPOSITORY_ITEM
- Identifier for a
GetRepositoryItem
request.
- See Also:
- Constant Field Values
TRANSACTION_NAME
public static final java.lang.String TRANSACTION_NAME
- See Also:
- Constant Field Values
HARVEST_NAME
public static final java.lang.String HARVEST_NAME
- See Also:
- Constant Field Values
CatalogueOperationsMetadata
public CatalogueOperationsMetadata(Operation getCapabilities,
Operation describeRecord,
Operation getDomain,
Operation getRecords,
Operation getRecordById,
Operation transaction,
Operation harvest,
OWSDomainType[] parameters,
OWSDomainType[] constraints)
- Constructs a new
CatalogOperationsMetadata
from the given parameters.
- Parameters:
getCapabilities
- describeRecord
- getDomain
- getRecords
- getRecordById
- transaction
- harvest
- parameters
- constraints
-
getOperations
public Operation[] getOperations()
- Returns all
Operations
.
- Overrides:
getOperations
in class OperationsMetadata
- Returns:
- all
Operations
.
getDescribeRecord
public Operation getDescribeRecord()
- Returns:
- the describeRecord.
setDescribeRecord
public void setDescribeRecord(Operation describeRecord)
- Parameters:
describeRecord
- The describeRecord to set.
getGetDomain
public Operation getGetDomain()
- Returns:
- the getDomain.
setGetDomain
public void setGetDomain(Operation getDomain)
- Parameters:
getDomain
- The getDomain to set.
getGetRecordById
public Operation getGetRecordById()
- Returns:
- the getRecordById.
setGetRecordById
public void setGetRecordById(Operation getRecordById)
- Parameters:
getRecordById
- The getRecordId to set.
getGetRecords
public Operation getGetRecords()
- Returns:
- the getRecords.
setGetRecords
public void setGetRecords(Operation getRecords)
- Parameters:
getRecords
- The getRecords to set.
getHarvest
public Operation getHarvest()
- Returns:
- the harvest.
setHarvest
public void setHarvest(Operation harvest)
- Parameters:
harvest
- The harvest to set.
getTransaction
public Operation getTransaction()
- Returns:
- the transaction.
setTransaction
public void setTransaction(Operation transaction)
- Parameters:
transaction
- The transaction to set.
an open source project founded by lat/lon, Bonn, Germany.
For more information visit: http://www.deegree.org