IndexedPersistenceEncoding.java

package mil.nga.giat.geowave.core.store.data;

import mil.nga.giat.geowave.core.index.ByteArrayId;

/**
 * This class models all of the necessary information for persisting data in the
 * data store (following the common index model) and is used internally within
 * GeoWave as an intermediary object between the direct storage format and the
 * native data format. It also contains information about the persisted object
 * within a particular index such as the insertion ID in the index and the
 * number of duplicates for this entry in the index, and is used when reading
 * data from the index.
 */
public class IndexedPersistenceEncoding<T> extends
		PersistenceEncoding<T>
{
	private final ByteArrayId indexInsertionId;
	private final int duplicateCount;

	public IndexedPersistenceEncoding(
			final ByteArrayId adapterId,
			final ByteArrayId dataId,
			final ByteArrayId indexInsertionId,
			final int duplicateCount,
			final PersistentDataset<T> commonData,
			final PersistentDataset<byte[]> unknownData ) {
		super(
				adapterId,
				dataId,
				commonData,
				unknownData);
		this.indexInsertionId = indexInsertionId;
		this.duplicateCount = duplicateCount;
	}

	/**
	 * Return the index ID, this is the ID that the entry inserted at given by
	 * the index
	 * 
	 * @return the index ID
	 */
	public ByteArrayId getIndexInsertionId() {
		return indexInsertionId;
	}

	@Override
	public boolean isDeduplicationEnabled() {
		return duplicateCount >= 0;
	}

	/**
	 * Return the number of duplicates for this entry. Entries are duplicated
	 * when a single row ID is insufficient to index it.
	 * 
	 * @return the number of duplicates
	 */
	public int getDuplicateCount() {
		return duplicateCount;
	}

	/**
	 * Return a flag indicating if the entry has any duplicates
	 * 
	 * @return is it duplicated?
	 */
	public boolean isDuplicated() {
		return duplicateCount > 0;
	}

}