Package com.luciad.opensearch.model

Class TLcdOpenSearchQuery

java.lang.Object
com.luciad.datamodel.TLcdDataObject
com.luciad.opensearch.model.TLcdOpenSearchQuery
All Implemented Interfaces:
ILcdDataObject, ILcdCloneable, ILcdDeepCloneable, Cloneable
public class TLcdOpenSearchQuery extends TLcdDataObject
Since:
2017.0

  • Field Details

    • COUNT_PROPERTY

      public static final TLcdDataProperty COUNT_PROPERTY
      Data property that maps to the count attribute. The possible values for this property are instances of Long.

    • INPUT_ENCODING_PROPERTY

      public static final TLcdDataProperty INPUT_ENCODING_PROPERTY
      Data property that maps to the inputEncoding attribute. The possible values for this property are instances of String.

    • LANGUAGE_PROPERTY

      public static final TLcdDataProperty LANGUAGE_PROPERTY
      Data property that maps to the language attribute. The possible values for this property are instances of String.

    • OUTPUT_ENCODING_PROPERTY

      public static final TLcdDataProperty OUTPUT_ENCODING_PROPERTY
      Data property that maps to the outputEncoding attribute. The possible values for this property are instances of String.

    • ROLE_PROPERTY

      public static final TLcdDataProperty ROLE_PROPERTY
      Data property that maps to the role attribute. The possible values for this property are instances of Role.

    • SEARCH_TERMS_PROPERTY

      public static final TLcdDataProperty SEARCH_TERMS_PROPERTY
      Data property that maps to the searchTerms attribute. The possible values for this property are instances of String.

    • START_INDEX_PROPERTY

      public static final TLcdDataProperty START_INDEX_PROPERTY
      Data property that maps to the startIndex attribute. The possible values for this property are instances of Long.

    • START_PAGE_PROPERTY

      public static final TLcdDataProperty START_PAGE_PROPERTY
      Data property that maps to the startPage attribute. The possible values for this property are instances of Long.

    • TITLE_PROPERTY

      public static final TLcdDataProperty TITLE_PROPERTY
      Data property that maps to the title attribute. The possible values for this property are instances of String.

    • TOTAL_RESULTS_PROPERTY

      public static final TLcdDataProperty TOTAL_RESULTS_PROPERTY
      Data property that maps to the totalResults attribute. The possible values for this property are instances of Long.

  • Constructor Details

    • TLcdOpenSearchQuery

      public TLcdOpenSearchQuery()

    • TLcdOpenSearchQuery

      public TLcdOpenSearchQuery(TLcdDataType aType)

  • Method Details

    • getCount

      public Long getCount()
      Returns the value of the property that maps to the count attribute.

      Contains the value representing the "count" as a OpenSearch 1.1 parameter. Search clients should anticipate that the value of the "count" parameter may not be honored by the search engine, and should rely exclusively on the contents of the "itemsPerPage" response element in calculating actual page size.

      Returns:
      the value of the COUNT_PROPERTY property.

    • setCount

      public void setCount(Long aValue)
      Sets the value of the property that maps to the count attribute.

      Contains the value representing the "count" as a OpenSearch 1.1 parameter. Search clients should anticipate that the value of the "count" parameter may not be honored by the search engine, and should rely exclusively on the contents of the "itemsPerPage" response element in calculating actual page size.

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

    • getInputEncoding

      public String getInputEncoding()
      Returns the value of the property that maps to the inputEncoding attribute.

      Contains the value representing the "inputEncoding" as an OpenSearch 1.1 parameter. Replaced with a string that indicates that the search client is performing the search request encoded with the specified character encoding. An OpenSearch description document should include one "InputEncoding" element for each character encoding that can be used to encode search requests. The "inputEncoding" template parameter in the OpenSearch URL template can be used to require the search client to identify which encoding is being used to encode the current search request. Restrictions: The value must conform to the XML 1.0 Character Encodings, as specified by the IANA Character Set Assignments.

      Returns:
      the value of the INPUT_ENCODING_PROPERTY property.

    • setInputEncoding

      public void setInputEncoding(String aValue)
      Sets the value of the property that maps to the inputEncoding attribute.

      Contains the value representing the "inputEncoding" as an OpenSearch 1.1 parameter. Replaced with a string that indicates that the search client is performing the search request encoded with the specified character encoding. An OpenSearch description document should include one "InputEncoding" element for each character encoding that can be used to encode search requests. The "inputEncoding" template parameter in the OpenSearch URL template can be used to require the search client to identify which encoding is being used to encode the current search request. Restrictions: The value must conform to the XML 1.0 Character Encodings, as specified by the IANA Character Set Assignments.

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

    • getLanguage

      public String getLanguage()
      Returns the value of the property that maps to the language attribute.

      Contains the value representing the "language" as an OpenSearch 1.1 parameter. Replaced with a string that indicates that the search client desires search results in the specified language. An OpenSearch description document should include one "Language" element for each language that the search engine supports. If the search engine also supports queries for any arbitrary language then the OpenSearch description document should include a Language element with a value of "*". The "language" template parameter in the OpenSearch URL template can be used to allow the search client to choose among the available languages. Restrictions: The value must conform to the XML 1.0 Language Identification, as specified by RFC 3066. In addition, a value of "*" will signify that the search client desires search results in any language.

      Returns:
      the value of the LANGUAGE_PROPERTY property.

    • setLanguage

      public void setLanguage(String aValue)
      Sets the value of the property that maps to the language attribute.

      Contains the value representing the "language" as an OpenSearch 1.1 parameter. Replaced with a string that indicates that the search client desires search results in the specified language. An OpenSearch description document should include one "Language" element for each language that the search engine supports. If the search engine also supports queries for any arbitrary language then the OpenSearch description document should include a Language element with a value of "*". The "language" template parameter in the OpenSearch URL template can be used to allow the search client to choose among the available languages. Restrictions: The value must conform to the XML 1.0 Language Identification, as specified by RFC 3066. In addition, a value of "*" will signify that the search client desires search results in any language.

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

    • getOutputEncoding

      public String getOutputEncoding()
      Returns the value of the property that maps to the outputEncoding attribute.

      Replaced with a string that indicates that the search client desires a search response encoding with the specified character encoding. An OpenSearch description document should include one "OutputEncoding" element for each character encoding that can be used to encode search responses. The "outputEncoding" template parameter in the OpenSearch URL template can be used to allow the search client to choose a character encoding in the search response. Restrictions: The value must conform to the XML 1.0 Character Encodings, as specified by the IANA Character Set Assignments.

      Returns:
      the value of the OUTPUT_ENCODING_PROPERTY property.

    • setOutputEncoding

      public void setOutputEncoding(String aValue)
      Sets the value of the property that maps to the outputEncoding attribute.

      Replaced with a string that indicates that the search client desires a search response encoding with the specified character encoding. An OpenSearch description document should include one "OutputEncoding" element for each character encoding that can be used to encode search responses. The "outputEncoding" template parameter in the OpenSearch URL template can be used to allow the search client to choose a character encoding in the search response. Restrictions: The value must conform to the XML 1.0 Character Encodings, as specified by the IANA Character Set Assignments.

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

    • getRole

      public TLcdOpenSearchQuery.Role getRole()
      Returns the value of the property that maps to the role attribute.

      role - Contains a string identifying how the search client should interpret the search request defined by this Query element. Role values: A role value consists of an optional prefix followed by the local role value. If the prefix is present it will be separated from the local role value with the ":" character. All role values are associated with a namespace, either implicitly in the case of local role values, or explicitly via a prefix in the case of fully qualified role values. Role extensibility: The role attribute may take on values beyond those specified in this document provided they are fully qualified with a prefix and associated with a declared namespace. Clients that encounter unrecognized role values should continue to process the document as if the Query element containing the unrecognized role value did not appear. Role prefix: A role prefix associates a local role name with a namespace. All prefixes must be previously declared as an XML namespace prefix on the containing Query element or ancestor elements. Local role values: Local role values are not preceded by a prefix. Local role values are associated with the OpenSearch 1.1 namespace. The following role values are identified with the OpenSearch 1.1 namespace. The list is exhaustive; only the role values listed below may appear in the OpenSearch 1.1 namespace. Role values:

      Returns:
      the value of the ROLE_PROPERTY property.

    • setRole

      public void setRole(TLcdOpenSearchQuery.Role aValue)
      Sets the value of the property that maps to the role attribute.

      role - Contains a string identifying how the search client should interpret the search request defined by this Query element. Role values: A role value consists of an optional prefix followed by the local role value. If the prefix is present it will be separated from the local role value with the ":" character. All role values are associated with a namespace, either implicitly in the case of local role values, or explicitly via a prefix in the case of fully qualified role values. Role extensibility: The role attribute may take on values beyond those specified in this document provided they are fully qualified with a prefix and associated with a declared namespace. Clients that encounter unrecognized role values should continue to process the document as if the Query element containing the unrecognized role value did not appear. Role prefix: A role prefix associates a local role name with a namespace. All prefixes must be previously declared as an XML namespace prefix on the containing Query element or ancestor elements. Local role values: Local role values are not preceded by a prefix. Local role values are associated with the OpenSearch 1.1 namespace. The following role values are identified with the OpenSearch 1.1 namespace. The list is exhaustive; only the role values listed below may appear in the OpenSearch 1.1 namespace. Role values:

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

    • getSearchTerms

      public String getSearchTerms()
      Returns the value of the property that maps to the searchTerms attribute.

      Contains the value representing the "searchTerms" as an OpenSearch 1.1 parameter. Restrictions: The value must be URL-encoded.

      Returns:
      the value of the SEARCH_TERMS_PROPERTY property.

    • setSearchTerms

      public void setSearchTerms(String aValue)
      Sets the value of the property that maps to the searchTerms attribute.

      Contains the value representing the "searchTerms" as an OpenSearch 1.1 parameter. Restrictions: The value must be URL-encoded.

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

    • getStartIndex

      public Long getStartIndex()
      Returns the value of the property that maps to the startIndex attribute.

      Contains the value representing the "startIndex" as an OpenSearch 1.1 parameter. Replaced with the index of the first search result desired by the search client. Default: The value specified by the "indexOffset" attribute of the containing Url element.

      Returns:
      the value of the START_INDEX_PROPERTY property.

    • setStartIndex

      public void setStartIndex(Long aValue)
      Sets the value of the property that maps to the startIndex attribute.

      Contains the value representing the "startIndex" as an OpenSearch 1.1 parameter. Replaced with the index of the first search result desired by the search client. Default: The value specified by the "indexOffset" attribute of the containing Url element.

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

    • getStartPage

      public Long getStartPage()
      Returns the value of the property that maps to the startPage attribute.

      Contains the value representing the "startPage" as an OpenSearch 1.1 parameter. Replaced with the page number of the set of search results desired by the search client. Default: The value specified by the "pageOffset" attribute of the containing Url element.

      Returns:
      the value of the START_PAGE_PROPERTY property.

    • setStartPage

      public void setStartPage(Long aValue)
      Sets the value of the property that maps to the startPage attribute.

      Contains the value representing the "startPage" as an OpenSearch 1.1 parameter. Replaced with the page number of the set of search results desired by the search client. Default: The value specified by the "pageOffset" attribute of the containing Url element.

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

    • getTitle

      public String getTitle()
      Returns the value of the property that maps to the title attribute.

      Contains a human-readable plain text string describing the search request.

      Returns:
      the value of the TITLE_PROPERTY property.

    • setTitle

      public void setTitle(String aValue)
      Sets the value of the property that maps to the title attribute.

      Contains a human-readable plain text string describing the search request.

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

    • getTotalResults

      public Long getTotalResults()
      Returns the value of the property that maps to the totalResults attribute.

      Contains the expected number of results to be found if the search request were made.

      Returns:
      the value of the TOTAL_RESULTS_PROPERTY property.

    • setTotalResults

      public void setTotalResults(Long aValue)
      Sets the value of the property that maps to the totalResults attribute.

      Contains the expected number of results to be found if the search request were made.

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