Package com.luciad.ogc.csw.model

Class TLcdCSWDistributedSearch

java.lang.Object
com.luciad.datamodel.TLcdDataObject
com.luciad.ogc.csw.model.TLcdCSWDistributedSearch
All Implemented Interfaces:
ILcdDataObject, ILcdCloneable, ILcdDeepCloneable, Cloneable
public class TLcdCSWDistributedSearch extends TLcdDataObject
Governs the behaviour of a distributed search. hopCount - the maximum number of message hops before the search is terminated. Each catalogue node decrements this value when the request is received, and must not forward the request if hopCount=0.
Since:
2017.0

  • Field Details

    • CLIENT_ID_PROPERTY

      public static final TLcdDataProperty CLIENT_ID_PROPERTY
      Data property that maps to the clientId attribute. The possible values for this property are instances of URI.

    • DISTRIBUTED_SEARCH_ID_PROPERTY

      public static final TLcdDataProperty DISTRIBUTED_SEARCH_ID_PROPERTY
      Data property that maps to the distributedSearchId attribute. The possible values for this property are instances of URI.

    • DISTRIBUTED_SEARCH_ID_TIMOUT_PROPERTY

      public static final TLcdDataProperty DISTRIBUTED_SEARCH_ID_TIMOUT_PROPERTY
      Data property that maps to the distributedSearchIdTimout attribute. The possible values for this property are instances of long.

    • HOP_COUNT_PROPERTY

      public static final TLcdDataProperty HOP_COUNT_PROPERTY
      Data property that maps to the hopCount attribute. The possible values for this property are instances of long.

    • FEDERATED_CATALOGUES_PROPERTY

      public static final TLcdDataProperty FEDERATED_CATALOGUES_PROPERTY
      Data property that maps to the federatedCatalogues element. The possible values for this property are instances of List<ILcdDataObject>.

  • Constructor Details

    • TLcdCSWDistributedSearch

      public TLcdCSWDistributedSearch()

    • TLcdCSWDistributedSearch

      public TLcdCSWDistributedSearch(TLcdDataType aType)

  • Method Details

    • getClientId

      public URI getClientId()
      Returns the value of the property that maps to the clientId attribute.

      An Id which uniquely identifies the requestor.

      Returns:
      the value of the CLIENT_ID_PROPERTY property.

    • setClientId

      public void setClientId(URI aValue)
      Sets the value of the property that maps to the clientId attribute.

      An Id which uniquely identifies the requestor.

      Parameters:
      aValue - the value to set for the CLIENT_ID_PROPERTY property.

    • getDistributedSearchId

      public URI getDistributedSearchId()
      Returns the value of the property that maps to the distributedSearchId attribute.

      Id which uniquely identifies a complete client initiated distributed search sequence/session.

      Returns:
      the value of the DISTRIBUTED_SEARCH_ID_PROPERTY property.

    • setDistributedSearchId

      public void setDistributedSearchId(URI aValue)
      Sets the value of the property that maps to the distributedSearchId attribute.

      Id which uniquely identifies a complete client initiated distributed search sequence/session.

      Parameters:
      aValue - the value to set for the DISTRIBUTED_SEARCH_ID_PROPERTY property.

    • getDistributedSearchIdTimout

      public long getDistributedSearchIdTimout()
      Returns the value of the property that maps to the distributedSearchIdTimout attribute.

      Defines how long (sec) the distributedSearchId should be valid, meaning how long a server involved in distributed search should minimally store information related to the distributedSearchId.

      Returns:
      the value of the DISTRIBUTED_SEARCH_ID_TIMOUT_PROPERTY property.

    • setDistributedSearchIdTimout

      public void setDistributedSearchIdTimout(long aValue)
      Sets the value of the property that maps to the distributedSearchIdTimout attribute.

      Defines how long (sec) the distributedSearchId should be valid, meaning how long a server involved in distributed search should minimally store information related to the distributedSearchId.

      Parameters:
      aValue - the value to set for the DISTRIBUTED_SEARCH_ID_TIMOUT_PROPERTY property.

    • getHopCount

      public long getHopCount()
      Returns the value of the property that maps to the hopCount attribute.
      Returns:
      the value of the HOP_COUNT_PROPERTY property.

    • setHopCount

      public void setHopCount(long aValue)
      Sets the value of the property that maps to the hopCount attribute.
      Parameters:
      aValue - the value to set for the HOP_COUNT_PROPERTY property.

    • getFederatedCatalogues

      public List<ILcdDataObject> getFederatedCatalogues()
      Returns the value of the property that maps to the federatedCatalogues element.

      To restrict the number of catalogues of a federation which should be searched upon an optional list of those catalogues can be provided within the federatedCatatalogues parameter.

      Returns:
      the value of the FEDERATED_CATALOGUES_PROPERTY property.