org.neo4j.graphdb.index

Class IndexPopulationProgress

java.lang.Object

org.neo4j.graphdb.index.IndexPopulationProgress

public class IndexPopulationProgress
extends Object

This class is simply a progress counter of indexing population progress. It has the constraint that 0 <= completed <= total

Use IndexPopulationProgress.NONE if you need an object without any particular progress.

Field Summary

Fields

Modifier and Type	Field and Description
static IndexPopulationProgress	DONE
static IndexPopulationProgress	NONE

Constructor Summary

Constructors

Constructor and Description
IndexPopulationProgress(long completed, long total)

Method Summary

Modifier and Type	Method and Description
long	getCompletedCount()
float	getCompletedPercentage()
long	getTotalCount()
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NONE

public static final IndexPopulationProgress NONE

DONE

public static final IndexPopulationProgress DONE

Constructor Detail

IndexPopulationProgress

public IndexPopulationProgress(long completed,
                               long total)

Method Detail

getCompletedPercentage

public float getCompletedPercentage()

Returns:

percentage (from 0 to 100) of totalCount items which have been indexed. If totalCount is 0, returns 0.

getCompletedCount

public long getCompletedCount()

Returns:

number of completed items

getTotalCount

public long getTotalCount()

Returns:

total number of items to index

toString

public String toString()

Overrides:

toString in class Object