org.apache.solr.schema

Class UUIDField

java.lang.Object

org.apache.solr.schema.FieldProperties

org.apache.solr.schema.FieldType

org.apache.solr.schema.UUIDField

public class UUIDField
extends FieldType

This FieldType accepts UUID string values, as well as the special value of "NEW" which triggers generation of a new random UUID.

Version:

$Id: UUIDField.java 945270 2010-05-17 17:45:18Z rmuir $

See Also:

UUID.toString(), UUID.randomUUID()

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.solr.schema.FieldType

FieldType.DefaultAnalyzer

Field Summary

Fields

Modifier and Type	Field and Description
private static char	DASH
private static java.lang.String	NEW

Fields inherited from class org.apache.solr.schema.FieldType

analyzer, args, falseProperties, log, POLY_FIELD_SEPARATOR, properties, queryAnalyzer, trueProperties, typeName

Fields inherited from class org.apache.solr.schema.FieldProperties

BINARY, INDEXED, MULTIVALUED, OMIT_NORMS, OMIT_POSITIONS, OMIT_TF_POSITIONS, propertyMap, propertyNames, REQUIRED, SORT_MISSING_FIRST, SORT_MISSING_LAST, STORE_TERMOFFSETS, STORE_TERMPOSITIONS, STORE_TERMVECTORS, STORED, TOKENIZED

Constructor Summary

Constructors

Constructor and Description
UUIDField()

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.search.SortField	getSortField(SchemaField field, boolean reverse) Returns the SortField instance that should be used to sort fields of this type.
protected void	init(IndexSchema schema, java.util.Map<java.lang.String,java.lang.String> args) subclasses should initialize themselves with the args provided and remove valid arguments.
java.lang.String	toInternal(java.lang.String val) Generates a UUID if val is either null, empty or "NEW".
java.lang.String	toInternal(java.util.UUID uuid)
java.util.UUID	toObject(org.apache.lucene.document.Fieldable f) Convert the stored-field format to an external object.
void	write(TextResponseWriter writer, java.lang.String name, org.apache.lucene.document.Fieldable f) calls back to TextResponseWriter to write the field value
void	write(XMLWriter xmlWriter, java.lang.String name, org.apache.lucene.document.Fieldable f) Renders the specified field as XML

Methods inherited from class org.apache.solr.schema.FieldType

createField, createField, createFields, getAnalyzer, getArg, getFieldIndex, getFieldQuery, getFieldStore, getFieldTermVec, getIndexOptions, getQueryAnalyzer, getRangeQuery, getStringSort, getTypeName, getValueSource, getValueSource, hasProperty, indexedToReadable, isMultiValued, isPolyField, isTokenized, multiValuedFieldCache, readableToIndexed, restrictProps, setAnalyzer, setArgs, setQueryAnalyzer, setTypeName, storedToIndexed, storedToReadable, toExternal, toString

Methods inherited from class org.apache.solr.schema.FieldProperties

getPropertyName, off, on, parseProperties, propertiesToString, propertyNameToInt

Methods inherited from class java.lang.Object

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

Field Detail

NEW

private static final java.lang.String NEW

See Also:

Constant Field Values

DASH

private static final char DASH

See Also:

Constant Field Values

Constructor Detail

UUIDField

public UUIDField()

Method Detail

init

protected void init(IndexSchema schema,
                    java.util.Map<java.lang.String,java.lang.String> args)

Description copied from class: FieldType

subclasses should initialize themselves with the args provided and remove valid arguments. leftover arguments will cause an exception. Common boolean properties have already been handled.

Overrides:

init in class FieldType

getSortField

public org.apache.lucene.search.SortField getSortField(SchemaField field,
                                                       boolean reverse)

Description copied from class: FieldType

Returns the SortField instance that should be used to sort fields of this type.

Specified by:

getSortField in class FieldType

See Also:

SchemaField.checkSortability()

write

public void write(XMLWriter xmlWriter,
                  java.lang.String name,
                  org.apache.lucene.document.Fieldable f)
           throws java.io.IOException

Description copied from class: FieldType

Renders the specified field as XML

Specified by:

write in class FieldType

Throws:

java.io.IOException

write

public void write(TextResponseWriter writer,
                  java.lang.String name,
                  org.apache.lucene.document.Fieldable f)
           throws java.io.IOException

Description copied from class: FieldType

calls back to TextResponseWriter to write the field value

Specified by:

write in class FieldType

Throws:

java.io.IOException

toInternal

public java.lang.String toInternal(java.lang.String val)

Generates a UUID if val is either null, empty or "NEW". Otherwise it behaves much like a StrField but checks that the value given is indeed a valid UUID.

Overrides:

toInternal in class FieldType

Parameters:

val - The value of the field

See Also:

FieldType.toInternal(java.lang.String)

toInternal

public java.lang.String toInternal(java.util.UUID uuid)

toObject

public java.util.UUID toObject(org.apache.lucene.document.Fieldable f)

Description copied from class: FieldType

Convert the stored-field format to an external object.

Overrides:

toObject in class FieldType

See Also:

FieldType.toInternal(java.lang.String)