Package ddf.catalog.data

Interface MetacardType

All Superinterfaces:

Serializable

All Known Subinterfaces:

QualifiedMetacardType

public interface MetacardType
extends Serializable

This class describes the set of attributes a Metacard can contain.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_METACARD_TYPE_NAME	Default name of the default MetacardType
static final String	METACARD_TYPE	The name for the value returned by getName() to be used when serializing the metacard type name.

Method Summary

Modifier and Type	Method	Description
AttributeDescriptor	getAttributeDescriptor(String attributeName)	Get the AttributeDescriptor for a particular Attribute name.
Set<AttributeDescriptor>	getAttributeDescriptors()	Returns the unmodifiable Set of AttributeDescriptors for this MetacardType.
String	getName()	Gets the name of this MetacardType.

Field Details

DEFAULT_METACARD_TYPE_NAME

static final String DEFAULT_METACARD_TYPE_NAME

Default name of the default MetacardType

See Also:

• Constant Field Values

METACARD_TYPE

static final String METACARD_TYPE

The name for the value returned by getName() to be used when serializing the metacard type name.

See Also:

• Constant Field Values

Method Details

getName

String getName()

Gets the name of this MetacardType. A MetacardType name must be unique. Two separate MetacardType objects that do not have the same set of AttributeDescriptors should not have the same name.

Returns:

the name of this MetacardType, default is DEFAULT_METACARD_TYPE_NAME;

getAttributeDescriptors

Set<AttributeDescriptor> getAttributeDescriptors()

Returns the unmodifiable Set of AttributeDescriptors for this MetacardType.

Returns:

See Also:

• Collections.unmodifiableSet(Set)

getAttributeDescriptor

AttributeDescriptor getAttributeDescriptor(String attributeName)

Get the AttributeDescriptor for a particular Attribute name.

Parameters:

attributeName -

Returns:

the AttributeDescriptor, null if not found.