org.neo4j.index.lucene
Class ValueContext

java.lang.Object
  org.neo4j.index.lucene.ValueContext

public class ValueContext
extends java.lang.Object

ValueContext allows you to give not just a value, but to give the value some context to live in.

Constructor Summary

ValueContext(java.lang.Object value)

Method Summary

java.lang.Object	getCorrectValue() Returns the string representation of the value given in the constructor, or the unmodified value if indexNumeric() has been called.
java.lang.Object	getValue()
ValueContext	indexNumeric() Returns a ValueContext to be used with Index.add(PropertyContainer, String, Object)
static ValueContext	numeric(java.lang.Number value) Convience method to add a numeric value to an index.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ValueContext

public ValueContext(java.lang.Object value)

Method Detail

getValue

public java.lang.Object getValue()

Returns:

the value object specified in the constructor.

indexNumeric

public ValueContext indexNumeric()

Returns a ValueContext to be used with Index.add(PropertyContainer, String, Object)

Returns:

a numeric ValueContext

getCorrectValue

public java.lang.Object getCorrectValue()

Returns the string representation of the value given in the constructor, or the unmodified value if indexNumeric() has been called.

Returns:

the, by the user, intended value to index.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

numeric

public static ValueContext numeric(java.lang.Number value)

Convience method to add a numeric value to an index.

Parameters:

value - The value to add

Returns:

A ValueContext that can be used with Index.add(PropertyContainer, String, Object)