Module org.apache.lucene.facet

Package org.apache.lucene.facet.taxonomy.directory

Class TaxonomyIndexArrays

java.lang.Object

org.apache.lucene.facet.taxonomy.ParallelTaxonomyArrays

org.apache.lucene.facet.taxonomy.directory.TaxonomyIndexArrays

All Implemented Interfaces:

Accountable

class TaxonomyIndexArrays
extends ParallelTaxonomyArrays
implements Accountable

A ParallelTaxonomyArrays that are initialized from the taxonomy index.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	TaxonomyIndexArrays.ChunkedIntArray

Nested classes/interfaces inherited from class org.apache.lucene.facet.taxonomy.ParallelTaxonomyArrays

ParallelTaxonomyArrays.IntArray

Field Summary

Fields

Modifier and Type	Field	Description
private TaxonomyIndexArrays.ChunkedIntArray	children
private static final int	CHUNK_MASK
(package private) static final int	CHUNK_SIZE
private static final int	CHUNK_SIZE_BITS
private boolean	initializedChildren
private final TaxonomyIndexArrays.ChunkedIntArray	parents
private TaxonomyIndexArrays.ChunkedIntArray	siblings

Fields inherited from interface org.apache.lucene.util.Accountable

NULL_ACCOUNTABLE

Constructor Summary

Constructors

Constructor	Description
TaxonomyIndexArrays(int[][] parents)	Used by add(int, int) after the array grew.
TaxonomyIndexArrays(IndexReader reader)
TaxonomyIndexArrays(IndexReader reader, TaxonomyIndexArrays copyFrom)

Method Summary

Modifier and Type	Method	Description
(package private) TaxonomyIndexArrays	add(int ordinal, int parentOrdinal)	Adds the given ordinal/parent info and returns either a new instance if the underlying array had to grow, or this instance otherwise.
private static int[][]	allocateChunkedArray(int size, int startFrom)
TaxonomyIndexArrays.ChunkedIntArray	children()	Returns the children array, where children[i] denotes the youngest child of category ordinal i.
private void	computeChildrenSiblings(int first)
private static void	copyChunkedArray(int[][] oldArray, int[][] newArray)
Collection<Accountable>	getChildResources()	Returns nested resources of this class.
private void	initChildrenSiblings(TaxonomyIndexArrays copyFrom)
private static void	initParents(int[][] parentsArray, IndexReader reader, int first)
TaxonomyIndexArrays.ChunkedIntArray	parents()	Returns the parents array, where parents[i] denotes the parent of category ordinal i.
long	ramBytesUsed()	Return the memory usage of this object in bytes.
TaxonomyIndexArrays.ChunkedIntArray	siblings()	Returns the siblings array, where siblings[i] denotes the sibling of category ordinal i.

Methods inherited from class java.lang.Object

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

Field Details

CHUNK_SIZE_BITS

private static final int CHUNK_SIZE_BITS

See Also:

• Constant Field Values

CHUNK_SIZE

static final int CHUNK_SIZE

See Also:

• Constant Field Values

CHUNK_MASK

private static final int CHUNK_MASK

See Also:

• Constant Field Values

parents

private final TaxonomyIndexArrays.ChunkedIntArray parents

initializedChildren

private volatile boolean initializedChildren

children

private TaxonomyIndexArrays.ChunkedIntArray children

siblings

private TaxonomyIndexArrays.ChunkedIntArray siblings

Constructor Details

TaxonomyIndexArrays

TaxonomyIndexArrays(int[][] parents)

Used by add(int, int) after the array grew. Also, used for testing.

TaxonomyIndexArrays

public TaxonomyIndexArrays(IndexReader reader)
                    throws IOException

Throws:

IOException

TaxonomyIndexArrays

public TaxonomyIndexArrays(IndexReader reader,
 TaxonomyIndexArrays copyFrom)
                    throws IOException

Throws:

IOException

Method Details

allocateChunkedArray

private static int[][] allocateChunkedArray(int size,
 int startFrom)

copyChunkedArray

private static void copyChunkedArray(int[][] oldArray,
 int[][] newArray)

initChildrenSiblings

private void initChildrenSiblings(TaxonomyIndexArrays copyFrom)

computeChildrenSiblings

private void computeChildrenSiblings(int first)

initParents

private static void initParents(int[][] parentsArray,
 IndexReader reader,
 int first)
                         throws IOException

Throws:

IOException

add

TaxonomyIndexArrays add(int ordinal,
 int parentOrdinal)

Adds the given ordinal/parent info and returns either a new instance if the underlying array had to grow, or this instance otherwise.

NOTE: you should call this method from a thread-safe code.

parents

public TaxonomyIndexArrays.ChunkedIntArray parents()

Returns the parents array, where parents[i] denotes the parent of category ordinal i.

Specified by:

parents in class ParallelTaxonomyArrays

children

public TaxonomyIndexArrays.ChunkedIntArray children()

Returns the children array, where children[i] denotes the youngest child of category ordinal i. The youngest child is defined as the category that was added last to the taxonomy as an immediate child of i.

Specified by:

children in class ParallelTaxonomyArrays

siblings

public TaxonomyIndexArrays.ChunkedIntArray siblings()

Returns the siblings array, where siblings[i] denotes the sibling of category ordinal i. The sibling is defined as the previous youngest child of parents[i].

Specified by:

siblings in class ParallelTaxonomyArrays

ramBytesUsed

public long ramBytesUsed()

Description copied from interface: Accountable

Return the memory usage of this object in bytes. Negative values are illegal.

Specified by:

ramBytesUsed in interface Accountable

getChildResources

public Collection<Accountable> getChildResources()

Description copied from interface: Accountable

Returns nested resources of this class. The result should be a point-in-time snapshot (to avoid race conditions).

Specified by:

getChildResources in interface Accountable

See Also:

• Accountables