Package org.codice.solr.query

Enum Class AttributeFormat

java.lang.Object

java.lang.Enum<AttributeFormat>

org.codice.solr.query.AttributeFormat

All Implemented Interfaces:

Serializable, Comparable<AttributeFormat>, Constable

public enum AttributeFormat
extends Enum<AttributeFormat>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BINARY	Attributes of this AttributeFormat must have a value that is a Java byte[] and AttributeType#getBinding() should return Class<Array> of byte.
BOOLEAN	Attributes of this AttributeFormat must have a value that is a Java Boolean.
DATE	Attributes of this AttributeFormat must have a value that is a Java Date.
DOUBLE	Attributes of this AttributeFormat must have a value that is a Java Double.
FLOAT	Attributes of this AttributeFormat must have a value that is a Java Float.
GEOMETRY	Attributes of this AttributeFormat must have a value that is a WKT-formatted Java String.
INTEGER	Attributes of this AttributeFormat must have a value that is a Java Integer.
LONG	Attributes of this AttributeFormat must have a value that is a Java Long.
OBJECT	Attributes of this AttributeFormat must have a value that implements the Serializable interface.
SHORT	Attributes of this AttributeFormat must have a value that is a Java Short.
STRING	Attributes of this AttributeFormat must have a value that is a Java String and treated as plain text.
XML	Attributes of this AttributeFormat must have a value that is a XML-formatted Java String.

Method Summary

Modifier and Type	Method	Description
static AttributeFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AttributeFormat[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

STRING

public static final AttributeFormat STRING

Attributes of this AttributeFormat must have a value that is a Java String and treated as plain text.

BOOLEAN

public static final AttributeFormat BOOLEAN

Attributes of this AttributeFormat must have a value that is a Java Boolean.

DATE

public static final AttributeFormat DATE

Attributes of this AttributeFormat must have a value that is a Java Date.

SHORT

public static final AttributeFormat SHORT

Attributes of this AttributeFormat must have a value that is a Java Short.

INTEGER

public static final AttributeFormat INTEGER

Attributes of this AttributeFormat must have a value that is a Java Integer.

LONG

public static final AttributeFormat LONG

Attributes of this AttributeFormat must have a value that is a Java Long.

FLOAT

public static final AttributeFormat FLOAT

Attributes of this AttributeFormat must have a value that is a Java Float.

DOUBLE

public static final AttributeFormat DOUBLE

Attributes of this AttributeFormat must have a value that is a Java Double.

GEOMETRY

public static final AttributeFormat GEOMETRY

Attributes of this AttributeFormat must have a value that is a WKT-formatted Java String.

BINARY

public static final AttributeFormat BINARY

Attributes of this AttributeFormat must have a value that is a Java byte[] and AttributeType#getBinding() should return Class<Array> of byte.

XML

public static final AttributeFormat XML

Attributes of this AttributeFormat must have a value that is a XML-formatted Java String.

OBJECT

public static final AttributeFormat OBJECT

Attributes of this AttributeFormat must have a value that implements the Serializable interface. Additional processing ( indexing, tokenizing) will not be performed even if indicated by the AttributeDescriptor.

NOTE: In order for classes to be deserialized by a Source, that class must exist on the classpath of that Source. This may require additional parameters to be set such as DynamicImport-Package in order for the Source to accommodate OBJECT format.

See Also:

• Serializable

Method Details

values

public static AttributeFormat[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static AttributeFormat valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null