ddf.catalog.util.impl

Class DescribableImpl

java.lang.Object

ddf.catalog.util.impl.DescribableImpl

All Implemented Interfaces:

Describable

Direct Known Subclasses:

CatalogFrameworkImpl, MaskableImpl, QueryOperations, ResourceOperations, SourceDescriptorImpl, SourceOperations

public abstract class DescribableImpl
extends Object
implements Describable

Default implementation of the Describable interface, providing basic setter/getter methods for a describable item's ID, title, version, organization, and description.

Author:

ddf.isgs@lmco.com

Constructor Summary

Constructors

Constructor and Description
DescribableImpl()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns a description of the describable item.
String	getId() Returns the name, aka ID, of the describable item.
String	getOrganization() Returns the organization associated with the describable item.
String	getTitle() Returns the title of the describable item.
String	getVersion() Retrieve the version.
void	setDescription(String description) Sets the description of the describable item.
void	setId(String id) Sets the ID of the describable item.
void	setOrganization(String organization) Sets the organization of the describable item.
void	setShortname(String shortname) Deprecated.
void	setTitle(String title) Sets the title of the describable item.
void	setVersion(String version) Sets the version of the describable item.

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribableImpl

public DescribableImpl()

Method Detail

getVersion

public String getVersion()

Description copied from interface: Describable

Retrieve the version.

Specified by:

getVersion in interface Describable

Returns:

the version of the item being described (example: 1.0)

setVersion

public void setVersion(String version)

Sets the version of the describable item.

Parameters:

version -

getId

public String getId()

Description copied from interface: Describable

Returns the name, aka ID, of the describable item. The name should be unique for each instance.
Example: html for a MetacardTransformer that transforms Metacards to HTML

Specified by:

getId in interface Describable

Returns:

ID of the item

setId

public void setId(String id)

Sets the ID of the describable item.

Parameters:

id -

setShortname

public void setShortname(String shortname)

Deprecated.

Parameters:

shortname -

getTitle

public String getTitle()

Description copied from interface: Describable

Returns the title of the describable item. It is generally more verbose than the name (aka ID).

Specified by:

getTitle in interface Describable

Returns:

title of the item (example: Dummy Catalog Provider)

setTitle

public void setTitle(String title)

Sets the title of the describable item.

Parameters:

title -

getDescription

public String getDescription()

Description copied from interface: Describable

Returns a description of the describable item.

Specified by:

getDescription in interface Describable

Returns:

description of the item (example: Provider that returns back static results)

setDescription

public void setDescription(String description)

Sets the description of the describable item.

Parameters:

description -

getOrganization

public String getOrganization()

Description copied from interface: Describable

Returns the organization associated with the describable item.

Specified by:

getOrganization in interface Describable

Returns:

organizational name or acronym (example: USAF)

setOrganization

public void setOrganization(String organization)

Sets the organization of the describable item.

Parameters:

organization -