com.esri.gpt.catalog.schema
Class Meaning

java.lang.Object
  com.esri.gpt.catalog.schema.Meaning

public class Meaning
extends Object

Stores values that ascribe meaning to a document.

Most schema parameters are treated in an abstract fashion, their associated meaning is unknown. Several parameters are critical for publication and meaning is required. The meaning for a parameter is specified within the XML defining the schema. Example:
<parameter key="identification.title" meaning="title">

Field Summary

static String	MEANINGTYPE_ABSTRACT Document abstract = "abstract"
static String	MEANINGTYPE_CONTENTTYPE Content type = "content.type"
static String	MEANINGTYPE_DATATHEME Data theme (i.e ISO topic category) = "dataTheme"
static String	MEANINGTYPE_ENVELOPE_EAST Bounding envelope east = "envelope.east"
static String	MEANINGTYPE_ENVELOPE_NORTH Bounding envelope north = "envelope.north"
static String	MEANINGTYPE_ENVELOPE_SOUTH Bounding envelope south = "envelope.south"
static String	MEANINGTYPE_ENVELOPE_WEST Bounding envelope west = "envelope.west"
static String	MEANINGTYPE_ESRIDOCID ESRI tag document identifier = "esriDocID"
static String	MEANINGTYPE_FILEIDENTIFIER File identifier = "fileIdentifier"
static String	MEANINGTYPE_NONE No meaning = "none" (this is the default)
static String	MEANINGTYPE_RESOURCE_TYPE Resource type = "resource.type"
static String	MEANINGTYPE_RESOURCE_URL Resource URL = "resource.url"
static String	MEANINGTYPE_THUMBNAIL_BINARY Thumbnail binary = "thumbnail.binary"
static String	MEANINGTYPE_THUMBNAIL_URL Thumbnail URL = "thumbnail.url"
static String	MEANINGTYPE_TITLE Document title = "title"
static String	MEANINGTYPE_TITLE_ORG original title
static String	MEANINGTYPE_WEBSITE_URL Website URL = "website.url"

Constructor Summary

protected

Meaning(PropertyMeanings propertyMeanings) Construct with a configured collection of property meanings.

Method Summary

protected void	applyEsriTags(Schema schema, EsriTags esriTags) Applies meaning associated with evaluated ESRI tags
void	echo(StringBuffer sb) Appends property information for the component to a StringBuffer.
void	evaluate(Parameter parameter) Evaluates a parameter's meaning.
String	getArcIMSContentType() Gets the ArcIMS content type.
Envelope	getEnvelope() Gets the bounding envelope.
String	getEsriDocID() Gets the value the ESRI tagged document UUID.
String	getFileIdentifier() Gets the file identifier.
PropertyMeanings	getPropertyMeanings() Gets the configured property meanings.
String	getResourceUrl() Gets the resource url.
IStoreables	getStoreables() Gets store-able properties associated with the eveluated schema.
String	getThumbnailBinary() Gets the base64 encoded string for the thumbnail image.
String	getThumbnailUrl() Gets the thumbnail url.
String	getTitle() Gets the title.
String	getWebsiteUrl() Gets the website url.
static String	makeResourceUrl(EsriTags esriTags, Meaning meaning) Makes a resource URL from a set of ESRI tyags.
void	setArcIMSContentType(String type) Sets the ArcIMS content type.
void	setEsriDocID(String id) Sets the value the ESRI tagged document UUID.
void	setFileIdentifier(String identifier) Sets the file identifier.
void	setThumbnailBinary(String base64) Sets the base64 encoded string for the thumbnail image.
void	setThumbnailUrl(String url) Sets the thumbnail URL.
void	setTitle(String title) Sets the title.

Methods inherited from class java.lang.Object

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

Field Detail

MEANINGTYPE_ABSTRACT

public static final String MEANINGTYPE_ABSTRACT

Document abstract = "abstract"

See Also:

Constant Field Values

MEANINGTYPE_CONTENTTYPE

public static final String MEANINGTYPE_CONTENTTYPE

Content type = "content.type"

See Also:

Constant Field Values

MEANINGTYPE_DATATHEME

public static final String MEANINGTYPE_DATATHEME

Data theme (i.e ISO topic category) = "dataTheme"

See Also:

Constant Field Values

MEANINGTYPE_ENVELOPE_EAST

public static final String MEANINGTYPE_ENVELOPE_EAST

Bounding envelope east = "envelope.east"

See Also:

Constant Field Values

MEANINGTYPE_ENVELOPE_NORTH

public static final String MEANINGTYPE_ENVELOPE_NORTH

Bounding envelope north = "envelope.north"

See Also:

Constant Field Values

MEANINGTYPE_ENVELOPE_SOUTH

public static final String MEANINGTYPE_ENVELOPE_SOUTH

Bounding envelope south = "envelope.south"

See Also:

Constant Field Values

MEANINGTYPE_ENVELOPE_WEST

public static final String MEANINGTYPE_ENVELOPE_WEST

Bounding envelope west = "envelope.west"

See Also:

Constant Field Values

MEANINGTYPE_ESRIDOCID

public static final String MEANINGTYPE_ESRIDOCID

ESRI tag document identifier = "esriDocID"

See Also:

Constant Field Values

MEANINGTYPE_FILEIDENTIFIER

public static final String MEANINGTYPE_FILEIDENTIFIER

File identifier = "fileIdentifier"

See Also:

Constant Field Values

MEANINGTYPE_NONE

public static final String MEANINGTYPE_NONE

No meaning = "none" (this is the default)

See Also:

Constant Field Values

MEANINGTYPE_RESOURCE_TYPE

public static final String MEANINGTYPE_RESOURCE_TYPE

Resource type = "resource.type"

See Also:

Constant Field Values

MEANINGTYPE_RESOURCE_URL

public static final String MEANINGTYPE_RESOURCE_URL

Resource URL = "resource.url"

See Also:

Constant Field Values

MEANINGTYPE_THUMBNAIL_BINARY

public static final String MEANINGTYPE_THUMBNAIL_BINARY

Thumbnail binary = "thumbnail.binary"

See Also:

Constant Field Values

MEANINGTYPE_THUMBNAIL_URL

public static final String MEANINGTYPE_THUMBNAIL_URL

Thumbnail URL = "thumbnail.url"

See Also:

Constant Field Values

MEANINGTYPE_TITLE

public static final String MEANINGTYPE_TITLE

Document title = "title"

See Also:

Constant Field Values

MEANINGTYPE_TITLE_ORG

public static final String MEANINGTYPE_TITLE_ORG

original title

See Also:

Constant Field Values

MEANINGTYPE_WEBSITE_URL

public static final String MEANINGTYPE_WEBSITE_URL

Website URL = "website.url"

See Also:

Constant Field Values

Constructor Detail

Meaning

protected Meaning(PropertyMeanings propertyMeanings)

Construct with a configured collection of property meanings. propertyMeanings the configured property meanings

Method Detail

getArcIMSContentType

public String getArcIMSContentType()

Gets the ArcIMS content type.

Returns:

the ArcIMS content type

setArcIMSContentType

public void setArcIMSContentType(String type)

Sets the ArcIMS content type.

Parameters:

type - the ArcIMS content type

getEnvelope

public Envelope getEnvelope()

Gets the bounding envelope.

Returns:

the bounding envelope

getEsriDocID

public String getEsriDocID()

Gets the value the ESRI tagged document UUID.
The underlying value is associated with a special ESRI tag used by ArcCatalog to uniquely identify the document.

Returns:

the ESRI tagged document UUID

setEsriDocID

public void setEsriDocID(String id)

Sets the value the ESRI tagged document UUID.
The underlying value is associated with a special ESRI tag used by ArcCatalog to uniquely identify the document.

Parameters:

id - the ESRI tagged document UUID

getFileIdentifier

public String getFileIdentifier()

Gets the file identifier.
The file identifier is typically associated with ISO-19139 documents.

Returns:

the file identifier

setFileIdentifier

public void setFileIdentifier(String identifier)

Sets the file identifier.
The file identifier is typically associated with ISO-19139 documents.

Parameters:

identifier - the file identifier

getPropertyMeanings

public PropertyMeanings getPropertyMeanings()

Gets the configured property meanings.

Returns:

the property meanings

getResourceUrl

public String getResourceUrl()

Gets the resource url.

Returns:

the resource url

getStoreables

public IStoreables getStoreables()

Gets store-able properties associated with the eveluated schema.

Returns:

the store-able properties

getThumbnailBinary

public String getThumbnailBinary()

Gets the base64 encoded string for the thumbnail image.

Returns:

the base64 encoded string for the thumbnail image

setThumbnailBinary

public void setThumbnailBinary(String base64)

Sets the base64 encoded string for the thumbnail image.

Parameters:

base64 - the base64 encoded string for the thumbnail image

getThumbnailUrl

public String getThumbnailUrl()

Gets the thumbnail url.

Returns:

the thumbnail url

setThumbnailUrl

public void setThumbnailUrl(String url)

Sets the thumbnail URL.

Parameters:

url - the thumbnail URL

getTitle

public String getTitle()

Gets the title.

Returns:

the title

setTitle

public void setTitle(String title)

Sets the title.

Parameters:

title - the title

getWebsiteUrl

public String getWebsiteUrl()

Gets the website url.

Returns:

the website url

applyEsriTags

protected void applyEsriTags(Schema schema,
                             EsriTags esriTags)

Applies meaning associated with evaluated ESRI tags

Parameters:

schema - the schema to which evaluated meanings will be applied

esriTags - the evaluated ESRI tags

echo

public void echo(StringBuffer sb)

Appends property information for the component to a StringBuffer.
The method is intended to support "FINEST" logging.
super.echo should be invoked prior appending any local information.

Parameters:

sb - the StringBuffer to use when appending information

evaluate

public void evaluate(Parameter parameter)

Evaluates a parameter's meaning.

Parameters:

parameter - the subject parameter

makeResourceUrl

public static String makeResourceUrl(EsriTags esriTags,
                                     Meaning meaning)

Makes a resource URL from a set of ESRI tyags.

Parameters:

esriTags - the set of ESRI tags

meaning - meaning