org.neo4j.kernel.api.impl.labelscan.storestrategy

Enum BitmapDocumentFormat

java.lang.Object

java.lang.Enum<BitmapDocumentFormat>

org.neo4j.kernel.api.impl.labelscan.storestrategy.BitmapDocumentFormat

All Implemented Interfaces:

Serializable, Comparable<BitmapDocumentFormat>

public enum BitmapDocumentFormat
extends Enum<BitmapDocumentFormat>

Enum Constant Summary

Enum Constants

Enum Constant and Description
_32
_64

Field Summary

Fields

Modifier and Type	Field and Description
static String	LABEL
static String	RANGE

Method Summary

Modifier and Type	Method and Description
void	addLabelAndSearchFields(org.apache.lucene.document.Document document, long label, Bitmap bitmap)
void	addRangeValuesField(org.apache.lucene.document.Document doc, long range)
BitmapFormat	bitmapFormat()
boolean	isLabelBitmapField(org.apache.lucene.index.IndexableField field)
boolean	isRangeField(org.apache.lucene.index.IndexableField field)
boolean	isRangeOrLabelField(org.apache.lucene.index.IndexableField field)
org.apache.lucene.index.IndexableField	labelField(long key, long bitmap)
long	labelId(org.apache.lucene.index.IndexableField field)
org.apache.lucene.search.Query	labelQuery(int labelId)
org.apache.lucene.index.IndexableField	labelSearchField(long label)
org.apache.lucene.search.Query	labelsQuery(org.apache.lucene.search.BooleanClause.Occur occur, int[] labelIds) Builds a Query suitable for returning documents of nodes having all or any (depending on occur) of the given labelIds.
org.apache.lucene.index.IndexableField	rangeField(long range)
long	rangeOf(org.apache.lucene.index.IndexableField field)
org.apache.lucene.search.Query	rangeQuery(long range)
org.apache.lucene.index.Term	rangeTerm(org.apache.lucene.document.Document document)
org.apache.lucene.index.Term	rangeTerm(long range)
Bitmap	readBitmap(org.apache.lucene.index.IndexableField field)
String	toString()
static BitmapDocumentFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static BitmapDocumentFormat[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

_32

public static final BitmapDocumentFormat _32

_64

public static final BitmapDocumentFormat _64

Field Detail

RANGE

public static final String RANGE

See Also:

Constant Field Values

LABEL

public static final String LABEL

See Also:

Constant Field Values

Method Detail

values

public static BitmapDocumentFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BitmapDocumentFormat c : BitmapDocumentFormat.values())
    System.out.println(c);

Returns:

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

valueOf

public static BitmapDocumentFormat valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<BitmapDocumentFormat>

bitmapFormat

public BitmapFormat bitmapFormat()

rangeOf

public long rangeOf(org.apache.lucene.index.IndexableField field)

labelQuery

public org.apache.lucene.search.Query labelQuery(int labelId)

labelsQuery

public org.apache.lucene.search.Query labelsQuery(org.apache.lucene.search.BooleanClause.Occur occur,
                                                  int[] labelIds)

Builds a Query suitable for returning documents of nodes having all or any (depending on occur) of the given labelIds.

Parameters:

occur - BooleanClause.Occur to use in the query.

labelIds - label ids to query for.

Returns:

Query for searching for documents with (all or any) of the label ids.

rangeQuery

public org.apache.lucene.search.Query rangeQuery(long range)

rangeField

public org.apache.lucene.index.IndexableField rangeField(long range)

addRangeValuesField

public void addRangeValuesField(org.apache.lucene.document.Document doc,
                                long range)

labelField

public org.apache.lucene.index.IndexableField labelField(long key,
                                                         long bitmap)

addLabelAndSearchFields

public void addLabelAndSearchFields(org.apache.lucene.document.Document document,
                                    long label,
                                    Bitmap bitmap)

labelSearchField

public org.apache.lucene.index.IndexableField labelSearchField(long label)

labelId

public long labelId(org.apache.lucene.index.IndexableField field)

rangeTerm

public org.apache.lucene.index.Term rangeTerm(long range)

rangeTerm

public org.apache.lucene.index.Term rangeTerm(org.apache.lucene.document.Document document)

isRangeOrLabelField

public boolean isRangeOrLabelField(org.apache.lucene.index.IndexableField field)

isRangeField

public boolean isRangeField(org.apache.lucene.index.IndexableField field)

isLabelBitmapField

public boolean isLabelBitmapField(org.apache.lucene.index.IndexableField field)

readBitmap

public Bitmap readBitmap(org.apache.lucene.index.IndexableField field)