Package ddf.catalog.data

Interface AttributeDescriptor

All Superinterfaces:

Serializable

public interface AttributeDescriptor
extends Serializable

AttributeDescriptor describes an Attribute and associates it with a AttributeType

Method Summary

Modifier and Type	Method	Description
String	getName()	Returns the name of this AttributeDescriptor
AttributeType<?>	getType()	Returns the AttributeType of Attributes described by this AttributeDescriptor.
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.

Method Details

getName

String getName()

Returns the name of this AttributeDescriptor

Returns:

String - the name of this AttributeDescriptor

isMultiValued

boolean isMultiValued()

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

Returns:

whether or not it is multivalued

getType

AttributeType<?> getType()

Returns the AttributeType of Attributes described by this AttributeDescriptor.

Returns:

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

isIndexed

boolean isIndexed()

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.

Returns:

boolean - whether or not to index the associated Attribute

See Also:

• isStored()

isTokenized

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.

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).

Returns:

boolean - whether or not to tokenize values of associated Attributes

See Also:

• isStored()

isStored

boolean isStored()

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).

Returns:

boolean - whether or not to store this Attribute

See Also:

• isIndexed()