ddf.catalog.util.impl

Class CachedSource

java.lang.Object

ddf.catalog.util.impl.CachedSource

All Implemented Interfaces:

Source, Describable

public class CachedSource
extends Object
implements Source

Constructor Summary

Constructors

Constructor and Description
CachedSource(Source source)

Method Summary

Modifier and Type	Method and Description
void	checkStatus() Updates the cached Source with the current status of the wrapped source.
boolean	equals(Object o)
String	getAttributeValue(String attr) Returns the value of an arbitrary attribute
Set<ContentType>	getContentTypes() Gets the ContentTypes that are currently stored by the Source.
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.
ddf.catalog.util.impl.SourceStatus	getSourceStatus() Returns the known SourceStatus of this Cached Source.
String	getTitle() Returns the title of the describable item.
String	getVersion() Retrieve the version.
int	hashCode()
boolean	isAvailable() This method states whether this source is available, typically connecting and performing some sort of simple query or ping to the native catalog.
boolean	isAvailable(SourceMonitor callback) This method is the same as Source.isAvailable() but allows a caller to provide a SourceMonitor callback object which is meant to be used as a way for the Source to dynamically contact the caller with its availability.
SourceResponse	query(QueryRequest request)

Methods inherited from class java.lang.Object

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

Methods inherited from interface ddf.catalog.source.Source

getSecurityAttributes

Constructor Detail

CachedSource

public CachedSource(Source source)

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)

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

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)

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)

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)

isAvailable

public boolean isAvailable()

Description copied from interface: Source

This method states whether this source is available, typically connecting and performing some sort of simple query or ping to the native catalog.

This is expected to be an expensive operation, possibly involving network I/O. Typically only CatalogFramework implementations will call this and only periodically.

Specified by:

isAvailable in interface Source

Returns:

true - if the site is available (up), false - if the site is unavailable (down)

See Also:

ddf.catalog.util.SourcePoller

isAvailable

public boolean isAvailable(SourceMonitor callback)

Description copied from interface: Source

This method is the same as Source.isAvailable() but allows a caller to provide a SourceMonitor callback object which is meant to be used as a way for the Source to dynamically contact the caller with its availability. The intent is to return a boolean as to whether the Source is available at this very moment and also to use the SourceMonitor object to update the caller of this method if this Source's availability changes later in the future.

Specified by:

isAvailable in interface Source

Parameters:

callback - - used to notify the caller of this method when the Source object wants to update its availability.

Returns:

true - if the site is available (up), false - if the site is unavailable (down)

query

public SourceResponse query(QueryRequest request)
                     throws UnsupportedQueryException

Specified by:

query in interface Source

Parameters:

request - the query to execute

Returns:

a SourceResponse with query results and query response details

Throws:

UnsupportedQueryException - when the query is not understood, malformed, or not supported by a Source

getContentTypes

public Set<ContentType> getContentTypes()

Description copied from interface: Source

Gets the ContentTypes that are currently stored by the Source. Notice the return object is a Set, meaning it returns all unique content types found in the Source without duplications.

Specified by:

getContentTypes in interface Source

Returns:

a Set of ContentTypes currently available from this Source.

getSourceStatus

public ddf.catalog.util.impl.SourceStatus getSourceStatus()

Returns the known SourceStatus of this Cached Source. The value represents the cached status of the last check for the source. It can either be available, unavailable, or never been tested (unchecked).

Returns:

The SourceStatus for this Source

checkStatus

public void checkStatus()

Updates the cached Source with the current status of the wrapped source. The wrapped source is tested to be available, and if it is available, the contentTypes will also be cached.

getAttributeValue

public String getAttributeValue(String attr)

Returns the value of an arbitrary attribute

Parameters:

attr - The attribute value requested

Returns:

The attribute Value

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object