ddf.catalog.data.metacardtype

Class MetacardTypeRegistryImpl

java.lang.Object

ddf.catalog.data.metacardtype.MetacardTypeRegistryImpl

All Implemented Interfaces:

MetacardTypeRegistry

public final class MetacardTypeRegistryImpl
extends Object
implements MetacardTypeRegistry

Default implementation of the MetacardTypeRegistry.

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

Field Summary

Fields inherited from interface ddf.catalog.data.MetacardTypeRegistry

METACARD_TYPE_NAME_KEY, METACARD_TYPE_NAMESPACE_KEY

Method Summary

Modifier and Type	Method and Description
static MetacardTypeRegistry	getInstance()
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.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static MetacardTypeRegistry getInstance()

register

public void register(QualifiedMetacardType qualifiedMetacardType)
              throws IllegalArgumentException

Description copied from interface: MetacardTypeRegistry

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.

Specified by:

register in interface MetacardTypeRegistry

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.

lookup

public QualifiedMetacardType lookup(String namespace,
                                    String metacardTypeName)
                             throws IllegalArgumentException

Description copied from interface: MetacardTypeRegistry

Gets the MetacardType identified by the namespace and MetacardType name.

Specified by:

lookup in interface MetacardTypeRegistry

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

public QualifiedMetacardType lookup(String metacardTypeName)
                             throws IllegalArgumentException

Description copied from interface: MetacardTypeRegistry

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

Specified by:

lookup in interface MetacardTypeRegistry

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.

unregister

public void unregister(QualifiedMetacardType qualifiedMetacardType)
                throws IllegalArgumentException,
                       MetacardTypeUnregistrationException

Description copied from interface: MetacardTypeRegistry

Removes from the registry the given QualifiedMetacardType.

Specified by:

unregister in interface MetacardTypeRegistry

Parameters:

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

Throws:

IllegalArgumentException

MetacardTypeUnregistrationException

getRegisteredTypes

public Set<QualifiedMetacardType> getRegisteredTypes()

Description copied from interface: MetacardTypeRegistry

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

Specified by:

getRegisteredTypes in interface MetacardTypeRegistry

Returns:

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