ddf.catalog.data.impl

Class AttributeDescriptorImpl

java.lang.Object

ddf.catalog.data.impl.AttributeDescriptorImpl

All Implemented Interfaces:

AttributeDescriptor, Serializable

Direct Known Subclasses:

FeatureAttributeDescriptor

public class AttributeDescriptorImpl
extends Object
implements AttributeDescriptor

Simple implementation of AttributeDescriptor

This class does not have a custom serialization implementation (like some other API classes such as AttributeImpl) because its physical representation is the same as its logical representation, which according to Joshua Bloch in Effective Java, Second Edition makes it a good candidate for the default Java serialization implementation.

For what constitutes a compatible change in serialization, see Sun's Guidelines.

Author:

ddf.isgs@lmco.com

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	indexed
protected boolean	multivalued
protected String	name
protected boolean	stored
protected boolean	tokenized
protected AttributeType<?>	type

Constructor Summary

Constructors

Constructor and Description
AttributeDescriptorImpl(String name, boolean indexed, boolean stored, boolean tokenized, boolean multivalued, AttributeType<?> type) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getName() Returns the name of this AttributeDescriptor
AttributeType<?>	getType() Returns the AttributeType of Attributes described by this AttributeDescriptor.
int	hashCode()
boolean	isIndexed() Whether or not this Attribute should be indexed by Source implementations, therefore part of Query evaluation.
boolean	isMultiValued() Returns whether or not Attributes described by this AttributeDescriptor are multivalued, that is, Attribute.getValue() returns a List.
boolean	isStored() Returns whether or not Source implementations must store the value of this Attribute.
boolean	isTokenized() If the AttributeType.AttributeFormat of this Attribute is AttributeType.AttributeFormat.STRING, returns whether or not Source implementations should tokenize it; removing stopwords, etc.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

indexed

protected boolean indexed

stored

protected boolean stored

tokenized

protected boolean tokenized

multivalued

protected boolean multivalued

type

protected AttributeType<?> type

Constructor Detail

AttributeDescriptorImpl

public AttributeDescriptorImpl(String name,
                               boolean indexed,
                               boolean stored,
                               boolean tokenized,
                               boolean multivalued,
                               AttributeType<?> type)

Constructor

Parameters:

name - - the name of this AttributeDescriptor

indexed - - whether Attribute values using this AttributeDescriptor should be indexed

stored - - whether Attribute values using this AttributeDescriptor should be stored

tokenized - - whether Attribute values using this AttributeDescriptor should be tokenized

multivalued - whether Attribute values using this AttributeDescriptor are multivalued

type - - the type of this AttributeDescriptor

See Also:

AttributeDescriptor.isIndexed(), AttributeDescriptor.isStored(), AttributeDescriptor.isTokenized(), AttributeDescriptor.isMultiValued()

Method Detail

getName

public String getName()

Description copied from interface: AttributeDescriptor

Returns the name of this AttributeDescriptor

Specified by:

getName in interface AttributeDescriptor

Returns:

String - the name of this AttributeDescriptor

getType

public AttributeType<?> getType()

Description copied from interface: AttributeDescriptor

Returns the AttributeType of Attributes described by this AttributeDescriptor.

Specified by:

getType in interface AttributeDescriptor

Returns:

AttributeType - the type of values of Attributes described by this AttributeDescriptor

isIndexed

public boolean isIndexed()

Description copied from interface: AttributeDescriptor

Whether or not this Attribute should be indexed by Source implementations, therefore part of Query evaluation.
Some Attributes may only want to be stored, not indexed.

Specified by:

isIndexed in interface AttributeDescriptor

Returns:

boolean - whether or not to index the associated Attribute

See Also:

AttributeDescriptor.isStored()

isStored

public boolean isStored()

Description copied from interface: AttributeDescriptor

Returns whether or not Source implementations must store the value of this Attribute. Some Attributes may only need to be indexed, not stored (or vice versa).

Specified by:

isStored in interface AttributeDescriptor

Returns:

boolean - whether or not to store this Attribute

See Also:

AttributeDescriptor.isIndexed()

isTokenized

public boolean isTokenized()

Description copied from interface: AttributeDescriptor

If the AttributeType.AttributeFormat of this Attribute is AttributeType.AttributeFormat.STRING, returns whether or not Source implementations should tokenize it; removing stopwords, etc.

This method is only relevant to Attributes with an AttributeType.AttributeFormat of AttributeType.AttributeFormat.STRING Some Attributes may only need to be stored, not indexed (or vice versa).

Specified by:

isTokenized in interface AttributeDescriptor

Returns:

boolean - whether or not to tokenize values of associated Attributes

See Also:

AttributeDescriptor.isStored()

isMultiValued

public boolean isMultiValued()

Description copied from interface: AttributeDescriptor

Returns whether or not Attributes described by this AttributeDescriptor are multivalued, that is, Attribute.getValue() returns a List.

Specified by:

isMultiValued in interface AttributeDescriptor

Returns:

whether or not it is multivalued

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object