Package ddf.catalog.data

Interface MetacardTypeRegistry

public interface MetacardTypeRegistry

Registry to maintain MetacardTypes that are supported by the system's Endpoints and Sources. MetacardTypes describe the attributes in a specific Metacard. This registry allows other DDF components to lookup MetacardTypes based on their qualified name. MetacardTypes should typically be registered by Sources that support that data set. Lookups will typically be performed by InputTransformers to discover how the incoming metadata should be parsed.

This code is experimental. While this interface is functional and tested, it may change or be removed in a future version of the library.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	METACARD_TYPE_NAME_KEY
static final String	METACARD_TYPE_NAMESPACE_KEY

Method Summary

Modifier and Type	Method	Description
Set<QualifiedMetacardType>	getRegisteredTypes()	This must be invoked each time an updated view of the registered types is desired.
QualifiedMetacardType	lookup(String metacardTypeName)	Gets the MetacardType identified using the default namespace and the specified MetacardType name.
QualifiedMetacardType	lookup(String namespace, String metacardTypeName)	Gets the MetacardType identified by the namespace and MetacardType name.
void	register(QualifiedMetacardType qualifiedMetacardType)	Registers a QualifiedMetacardType in the system so that it is accessible to InputTransformers, MetacardTransformers, QueryResponseTransformers, and other components.
void	unregister(QualifiedMetacardType qualifiedMetacardType)	Removes from the registry the given QualifiedMetacardType.

Field Details

METACARD_TYPE_NAMESPACE_KEY

static final String METACARD_TYPE_NAMESPACE_KEY

See Also:

• Constant Field Values

METACARD_TYPE_NAME_KEY

static final String METACARD_TYPE_NAME_KEY

See Also:

• Constant Field Values

Method Details

register

void register(QualifiedMetacardType qualifiedMetacardType)
       throws IllegalArgumentException

Registers a QualifiedMetacardType in the system so that it is accessible to InputTransformers, MetacardTransformers, QueryResponseTransformers, and other components. This allows those components to know how to properly interpret a Metacard and its Attributes.

If the QualifiedMetacardType does not contain a namespace, the default namespace will be assumed.

Parameters:

qualifiedMetacardType - the QualifiedMetacardType to make available to the catalog framework.

Throws:

IllegalArgumentException - An IllegalArgumentException will be thrown if qualifiedMetacardType is null. An IllegalArgumentException will also be thrown if the QualifiedMetacardType 's name is null or empty.

unregister

void unregister(QualifiedMetacardType qualifiedMetacardType)
         throws IllegalArgumentException,
MetacardTypeUnregistrationException

Removes from the registry the given QualifiedMetacardType.

Parameters:

qualifiedMetacardType - The MetacardType to remove from the registry. Cannot be null or empty.

Throws:

IllegalArgumentException

MetacardTypeUnregistrationException

lookup

QualifiedMetacardType lookup(String namespace,
 String metacardTypeName)
                      throws IllegalArgumentException

Gets the MetacardType identified by the namespace and MetacardType name.

Parameters:

namespace - prefix qualifier in which the MetacardType name is unique.

metacardTypeName - unique name identifying MetacardType. Cannot be null or empty.

Returns:

QualifiedMetacardType matching provided namespace and metacardTypeName or null if no matching MetacardType can be found.

Throws:

IllegalArgumentException - if the namespace is null or if the metacardTypeName is null or empty.

lookup

QualifiedMetacardType lookup(String metacardTypeName)
                      throws IllegalArgumentException

Gets the MetacardType identified using the default namespace and the specified MetacardType name.

Parameters:

metacardTypeName - unique name identifying MetacardType. Cannot be null or empty.

Returns:

QualifiedMetacardType matching provided namespace and metacardTypeName or null if no matching MetacardType can be found.

Throws:

IllegalArgumentException - if the metacardTypeName is null or empty.

getRegisteredTypes

Set<QualifiedMetacardType> getRegisteredTypes()

This must be invoked each time an updated view of the registered types is desired.

Returns:

Unmodifiable copy of the set of registered MetacardTypes in the system.