org.fao.geonet.constants
Class Geonet.SearchResult

java.lang.Object
  org.fao.geonet.constants.Geonet.SearchResult

Enclosing class:

Geonet

public class Geonet.SearchResult
extends java.lang.Object

Parameters that can be used in searches. See the parameters for a more complete description.

See Also:

for default values.

Nested Class Summary

class	Geonet.SearchResult.Output
class	Geonet.SearchResult.Relation
class	Geonet.SearchResult.SortBy

Field Summary

static java.lang.String	ABSTRACT Parameter name: "abstract" - Free text field that searches in the abstract
static java.lang.String	ANY Parameter name: "any" - Free text field that searches in all the text fields of a metadata record
static java.lang.String	CATEGORY
static java.lang.String	DATE_FROM Parameter name: "dateFrom" - Start date from when the referenced resource was updated.
static java.lang.String	DATE_TO Parameter name: "dateTo" - End date until when the referenced resource was updated.
static java.lang.String	DIGITAL Parameter name: "digital" - Boolean that restricts results to those resources that describe digital data based on ISO19115 CI_PresentationFormCode codes Exact values indexed are defined in the Lucene indexing stylesheets.
static java.lang.String	DOWNLOAD Parameter name: "download" - Boolean that restricts results to those resources that have a files for download based on protocol values as defined in the Lucene indexing stylesheets.
static java.lang.String	DYNAMIC Parameter name: "dynamic" - Boolean that restricts results to those resources that have an interactive resource associated based on protocol values as defined in the Lucene indexing stylesheets.
static java.lang.String	EAST_BL Parameter name: "eastBL" - Highest Longitude value in floating point format (geographic coordinate) Default value is 180
static java.lang.String	EXTENDED Parameter name: "extended" - Boolean that indicates if search is done in simple or Advanced mode.
static java.lang.String	GROUP Parameter name: "group" - Limit search results to resources that are administered by the selected group.
static java.lang.String	HITS_PER_PAGE Parameter name: "hitsPerPage" - Number of results returned by the search engine.
static java.lang.String	INTERMAP Parameter name: "intermap" - Boolean that indicates if GUI shows the embedded InterMap (on) or defaults to the old GUI (off).
static java.lang.String	KEYWORD
static java.lang.String	KEYWORDS
static java.lang.String	NORTH_BL Parameter name: "northBL" - Highest Latitude value in floating point format (geographic coordinate) Default value is 90
static java.lang.String	OR
static java.lang.String	OUTPUT Parameter name: "output" - Display results as text only or with graphic overviews (default)
static java.lang.String	PAPER Parameter name: "paper" - Boolean that restricts results to those resources that describe Hardcopy data based on ISO19115 CI_PresentationFormCode codes Exact values indexed are defined in the Lucene indexing stylesheets.
static java.lang.String	PHRASE
static java.lang.String	PROFILE
static java.lang.String	PROTOCOL Parameter name: "protocol" - Searches the protocol field that's part of the online resources in ISO19115.
static java.lang.String	REGION Parameter name: "region" - Index value of a region.
static java.lang.String	RELATION Parameter name: "relation" - Defines the type of spatial query matching used See Geonet.SearchResult.Relation for possible values Default value is {@value Relation#OVERLAPS}
static java.lang.String	REMOTE Parameter name: "remote" - Boolean that indicates if search is done on the local repository or using Z39.50 for on the fly searches in remote catalogs.
static java.lang.String	SERVER
static java.lang.String	SERVERS
static java.lang.String	SIMILARITY Parameter name: "similarity" - Use the Lucene FuzzyQuery.
static java.lang.String	SITE_ID Parameter name: "siteId" - Limit search results to resources that originate from the selected catalog.
static java.lang.String	SORT_BY Parameter name: "sortBy" - Order results by (default), , or by
static java.lang.String	SOUTH_BL Parameter name: "southBL" - Lowest Latitude value in floating point format (geographic coordinate) Default value is -90
static java.lang.String	TEMPLATE Parameter name: "template" - Boolean that defines if normal resources are searched or templates are searched Values are y or n
static java.lang.String	THEME_KEY
static java.lang.String	TIMEOUT Parameter name: "timeout" - Time in seconds the Z39.50 search waits for responses from remote servers before timing out.
static java.lang.String	TITLE Parameter name: "title" - Free text field that searches in the title
static java.lang.String	TOPIC_CAT Parameter name: "topicCat" - Restrict search to resources that have the requested Topic Category set (ISO19115)
static java.lang.String	WEST_BL Parameter name: "westBL" - Lowest Longitude value in floating point format (geographic coordinate) Default value is -180
static java.lang.String	WITHOUT

Constructor Summary

Geonet.SearchResult()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

TITLE

public static final java.lang.String TITLE

Parameter name: "title" - Free text field that searches in the title

See Also:

Constant Field Values

ABSTRACT

public static final java.lang.String ABSTRACT

Parameter name: "abstract" - Free text field that searches in the abstract

See Also:

Constant Field Values

ANY

public static final java.lang.String ANY

Parameter name: "any" - Free text field that searches in all the text fields of a metadata record

See Also:

Constant Field Values

PHRASE

public static final java.lang.String PHRASE

See Also:

Constant Field Values

OR

public static final java.lang.String OR

See Also:

Constant Field Values

WITHOUT

public static final java.lang.String WITHOUT

See Also:

Constant Field Values

REGION

public static final java.lang.String REGION

Parameter name: "region" - Index value of a region. Used to retrieve the name and bounding box of the selected region

See Also:

Constant Field Values

SOUTH_BL

public static final java.lang.String SOUTH_BL

Parameter name: "southBL" - Lowest Latitude value in floating point format (geographic coordinate) Default value is -90

See Also:

Constant Field Values

NORTH_BL

public static final java.lang.String NORTH_BL

Parameter name: "northBL" - Highest Latitude value in floating point format (geographic coordinate) Default value is 90

See Also:

Constant Field Values

EAST_BL

public static final java.lang.String EAST_BL

Parameter name: "eastBL" - Highest Longitude value in floating point format (geographic coordinate) Default value is 180

See Also:

Constant Field Values

WEST_BL

public static final java.lang.String WEST_BL

Parameter name: "westBL" - Lowest Longitude value in floating point format (geographic coordinate) Default value is -180

See Also:

Constant Field Values

RELATION

public static final java.lang.String RELATION

Parameter name: "relation" - Defines the type of spatial query matching used See Geonet.SearchResult.Relation for possible values Default value is {@value Relation#OVERLAPS}

See Also:

Constant Field Values

DATE_FROM

public static final java.lang.String DATE_FROM

Parameter name: "dateFrom" - Start date from when the referenced resource was updated. Formatted as ISO 8601. For example 1970-08-19T06:01:00 or 1970-08-19

See Also:

Constant Field Values

DATE_TO

public static final java.lang.String DATE_TO

Parameter name: "dateTo" - End date until when the referenced resource was updated. Formatted as ISO 8601. For example 2008-01-23T10:05:00 or 2008-01-23

See Also:

Constant Field Values

KEYWORD

public static final java.lang.String KEYWORD

See Also:

Constant Field Values

KEYWORDS

public static final java.lang.String KEYWORDS

See Also:

Constant Field Values

THEME_KEY

public static final java.lang.String THEME_KEY

See Also:

Constant Field Values

CATEGORY

public static final java.lang.String CATEGORY

See Also:

Constant Field Values

TOPIC_CAT

public static final java.lang.String TOPIC_CAT

Parameter name: "topicCat" - Restrict search to resources that have the requested Topic Category set (ISO19115)

See Also:

Constant Field Values

PROTOCOL

public static final java.lang.String PROTOCOL

Parameter name: "protocol" - Searches the protocol field that's part of the online resources in ISO19115. Suggested values are those listed in the localized strings.xml files at /strings/protocolChoice/@value

See Also:

Constant Field Values

DOWNLOAD

public static final java.lang.String DOWNLOAD

Parameter name: "download" - Boolean that restricts results to those resources that have a files for download based on protocol values as defined in the Lucene indexing stylesheets. Values are "on" or "off" (default)

See Also:

Constant Field Values

DYNAMIC

public static final java.lang.String DYNAMIC

Parameter name: "dynamic" - Boolean that restricts results to those resources that have an interactive resource associated based on protocol values as defined in the Lucene indexing stylesheets. Values are "on" or "off" (default)

See Also:

Constant Field Values

DIGITAL

public static final java.lang.String DIGITAL

Parameter name: "digital" - Boolean that restricts results to those resources that describe digital data based on ISO19115 CI_PresentationFormCode codes Exact values indexed are defined in the Lucene indexing stylesheets. Values are "on" or "off" (default)

See Also:

Constant Field Values

PAPER

public static final java.lang.String PAPER

Parameter name: "paper" - Boolean that restricts results to those resources that describe Hardcopy data based on ISO19115 CI_PresentationFormCode codes Exact values indexed are defined in the Lucene indexing stylesheets. Values are "on" or "off" (default)

See Also:

Constant Field Values

SITE_ID

public static final java.lang.String SITE_ID

Parameter name: "siteId" - Limit search results to resources that originate from the selected catalog. The Site's short name should be used as value

See Also:

Constant Field Values

GROUP

public static final java.lang.String GROUP

Parameter name: "group" - Limit search results to resources that are administered by the selected group. The group ID should be used as value

See Also:

Constant Field Values

PROFILE

public static final java.lang.String PROFILE

See Also:

Constant Field Values

SERVER

public static final java.lang.String SERVER

See Also:

Constant Field Values

SERVERS

public static final java.lang.String SERVERS

See Also:

Constant Field Values

TEMPLATE

public static final java.lang.String TEMPLATE

Parameter name: "template" - Boolean that defines if normal resources are searched or templates are searched Values are y or n

See Also:

Constant Field Values

EXTENDED

public static final java.lang.String EXTENDED

Parameter name: "extended" - Boolean that indicates if search is done in simple or Advanced mode. Values are "on" or "off" (default)

See Also:

Constant Field Values

REMOTE

public static final java.lang.String REMOTE

Parameter name: "remote" - Boolean that indicates if search is done on the local repository or using Z39.50 for on the fly searches in remote catalogs. Values are "on" or "off" (default)

See Also:

Constant Field Values

TIMEOUT

public static final java.lang.String TIMEOUT

Parameter name: "timeout" - Time in seconds the Z39.50 search waits for responses from remote servers before timing out. Default is 20 seconds

See Also:

Constant Field Values

HITS_PER_PAGE

public static final java.lang.String HITS_PER_PAGE

Parameter name: "hitsPerPage" - Number of results returned by the search engine. Default is 10 results

See Also:

Constant Field Values

SIMILARITY

public static final java.lang.String SIMILARITY

Parameter name: "similarity" - Use the Lucene FuzzyQuery. Values range from 0.0 to 1.0 and defaults to 0.8

See Also:

Constant Field Values

OUTPUT

public static final java.lang.String OUTPUT

Parameter name: "output" - Display results as text only or with graphic overviews (default)

See Also:

Constant Field Values

SORT_BY

public static final java.lang.String SORT_BY

Parameter name: "sortBy" - Order results by (default), , or by

See Also:

Constant Field Values

INTERMAP

public static final java.lang.String INTERMAP

Parameter name: "intermap" - Boolean that indicates if GUI shows the embedded InterMap (on) or defaults to the old GUI (off). Values are "on" (default) or "off"

See Also:

Constant Field Values

Constructor Detail

Geonet.SearchResult

public Geonet.SearchResult()