GET_COLLECTION

GET_COLLECTION_INFO

Used in: REQUEST
Servers: Metadata (Browse)
Parent elements: GET_METADATA

<GET_COLLECTION_INFO	Attribute Description Table
collection ="words \| tags" orderby ="alphabet \| frequency \| queries" [alphabet] tag ="string" zcode ="string" > No Child Elements </GET_COLLECTION_INFO >
Bold: Attribute or child element is required.

Retrieves information about a metadata repository.

None

See COLLECTION_INFO for response.
When collection="words", every unique word in the database is listed. However, the word must be significant. Words such as "the" or "is" are not included. This list can be long and unusable depending on the size of the database. To reduce the list of words, it is highly recommended to always use tag.
When collection="tags", all other attributes are ignored.
When a metadata document is deleted, the words from that document remain in the collection. If a user runs a search on a word that is not in the collection, the word is added to the collection and marked as having been queried once but having no actual instances.

Attribute	Usage	Back to Top
collection	1 A collection is a set of zero or more published documents. A document is the set of metadata describing a dataset. A document is either unpublished or published. Unpublished documents coexist with datasets on local file systems. Published documents are accessible over the Internet through catalog services.
orderby	2 When collection has the value of "words", specifices whether to order the word alphabetically, by the frequency of the word, or by the number of queries that have been issued against the word.
tag	3 Defines the location of an element inside an XML tree. For example, the element "title" might be inside an XML structure such as <idinfo> <citation> <citeinfo> <title>...</title> </citeinfo> </citation> </idinfo> To define "title", the string value for this attribute would be "idinfo/citation/citeinfo/title".
zcode	4 Numeric code defining semantics from the GEO Attribute Set.

Example 1:	Back to Top
<?xml version="1.0" encoding="UTF-8" ?> <ARCXML version="1.1"> <REQUEST> <GET_METADATA> <GET_COLLECTION_INFO collection="words" orderby="frequency" tag="metadata/dataqual/lineage/srcinfo/srccite/citeinfo/origin" /> </GET_METADATA> </REQUEST> </ARCXML>