com.bigdata.stream

Class Stream.StreamIndexMetadata

java.lang.Object

com.bigdata.btree.IndexMetadata

com.bigdata.stream.Stream.StreamIndexMetadata

All Implemented Interfaces:

IKeyBuilderFactory, Externalizable, Serializable, Cloneable

Enclosing class:

Stream

public static class Stream.StreamIndexMetadata
extends IndexMetadata

Metadata for a named solution set.

Author:

Bryan Thompson

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Stream.StreamIndexMetadata.Options

Constructor Summary

Constructors

Constructor and Description
Stream.StreamIndexMetadata() De-serialization constructor only - DO NOT use this ctor for creating a new instance! It will result in a thrown exception, typically from IndexMetadata.firstCheckpoint().
Stream.StreamIndexMetadata(IIndexManager indexManager, Properties properties, String namespace, UUID indexUUID) Constructor used to configure a new named B+Tree.
Stream.StreamIndexMetadata(String name, UUID indexUUID) Constructor used to configure a new named BTree.
Stream.StreamIndexMetadata(UUID indexUUID) Constructor used to configure a new unnamed HTree.

Method Summary

Methods

Modifier and Type	Method and Description
Stream.StreamIndexMetadata	clone() Makes a copy of the persistent data, clearing the address of the IndexMetadata record on the cloned copy.
String	getStreamClassName() The name of a class derived from SolutionSetStream that will be used to re-load the index.
Stream.CompressionEnum	getStreamCompressionType()
void	readExternal(ObjectInput in)
void	setStreamClassName(String className)
void	setStreamCompressionType(Stream.CompressionEnum e)
protected void	toString(StringBuilder sb) Extension hook for IndexMetadata.toString().
void	writeExternal(ObjectOutput out)

Methods inherited from class com.bigdata.btree.IndexMetadata

firstCheckpoint, getAsynchronousIndexWriteConfiguration, getAsynchronousIndexWriteConfiguration, getBloomFilterFactory, getBranchingFactor, getBTreeClassName, getBtreeRecordCompressorFactory, getCheckpointClassName, getConflictResolver, getDeleteMarkers, getIndexSegmentBranchingFactor, getIndexSegmentBufferNodes, getIndexSegmentRecordCompressorFactory, getIndexType, getIndexUUID, getInitialDataServiceUUID, getKeyBuilder, getMaxRecLen, getMetadataAddr, getName, getNodeKeySerializer, getOverflowHandler, getPartitionMetadata, getPrimaryKeyBuilder, getProperty, getProperty, getRawRecords, getScatterSplitConfiguration, getSplitHandler, getTupleSerializer, getVersionTimestampFilters, getVersionTimestamps, getWriteRetentionQueueCapacity, getWriteRetentionQueueScan, isIsolatable, overflowCheckpoint, read, setBloomFilterFactory, setBranchingFactor, setBTreeClassName, setBtreeRecordCompressorFactory, setCheckpointClassName, setConflictResolver, setDeleteMarkers, setIndexSegmentBranchingFactor, setIndexSegmentBufferNodes, setIndexSegmentRecordCompressorFactory, setInitialDataServiceUUID, setIsolatable, setMaxRecLen, setNodeKeySerializer, setOverflowHandler, setPartitionMetadata, setRawRecords, setScatterSplitConfiguration, setSplitHandler, setTupleSerializer, setVersionTimestampFilters, setVersionTimestamps, setWriteRetentionQueueCapacity, setWriteRetentionQueueScan, toString, write

Methods inherited from class java.lang.Object

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

Constructor Detail

Stream.StreamIndexMetadata

public Stream.StreamIndexMetadata()

De-serialization constructor only - DO NOT use this ctor for creating a new instance! It will result in a thrown exception, typically from IndexMetadata.firstCheckpoint().

Stream.StreamIndexMetadata

public Stream.StreamIndexMetadata(UUID indexUUID)

Constructor used to configure a new unnamed HTree. The index UUID is set to the given value and all other fields are defaulted as explained at #HTreeIndexMetadata(Properties, String, UUID). Those defaults may be overridden using the various setter methods, but some values can not be safely overridden after the index is in use.

Parameters:

indexUUID - The indexUUID.

Throws:

IllegalArgumentException - if the indexUUID is null.

Stream.StreamIndexMetadata

public Stream.StreamIndexMetadata(String name,
                          UUID indexUUID)

Constructor used to configure a new named BTree. The index UUID is set to the given value and all other fields are defaulted as explained at #IndexMetadata(Properties, String, UUID). Those defaults may be overridden using the various setter methods, but some values can not be safely overridden after the index is in use.

Parameters:

name - The index name. When this is a scale-out index, the same name is specified for each index resource. However they will be registered on the journal under different names depending on the index partition to which they belong.

indexUUID - The indexUUID. The same index UUID MUST be used for all component indices in a scale-out index.

Throws:

IllegalArgumentException - if the indexUUID is null.

Stream.StreamIndexMetadata

public Stream.StreamIndexMetadata(IIndexManager indexManager,
                          Properties properties,
                          String namespace,
                          UUID indexUUID)

Constructor used to configure a new named B+Tree. The index UUID is set to the given value and all other fields are defaulted as explained at #getProperty(Properties, String, String, String). Those defaults may be overridden using the various setter methods.

Parameters:

indexManager - Optional. When given and when the IIndexManager is a scale-out IBigdataFederation, this object will be used to interpret the IndexMetadata.Options.INITIAL_DATA_SERVICE property.

properties - Properties object used to overridden the default values for this IndexMetadata instance.

namespace - The index name. When this is a scale-out index, the same name is specified for each index resource. However they will be registered on the journal under different names depending on the index partition to which they belong.

indexUUID - component indices in a scale-out index. The indexUUID. The same index UUID MUST be used for all

indexType - Type-safe enumeration specifying the type of the persistence class data structure (historically, this was always a B+Tree).

Throws:

IllegalArgumentException - if properties is null.

IllegalArgumentException - if indexUUID is null.

Method Detail

getStreamClassName

public final String getStreamClassName()

The name of a class derived from SolutionSetStream that will be used to re-load the index.

See Also:

Stream.StreamIndexMetadata.Options.STREAM_CLASS_NAME

setStreamClassName

public void setStreamClassName(String className)

getStreamCompressionType

public Stream.CompressionEnum getStreamCompressionType()

setStreamCompressionType

public void setStreamCompressionType(Stream.CompressionEnum e)

toString

protected void toString(StringBuilder sb)

Description copied from class: IndexMetadata

Extension hook for IndexMetadata.toString().

Overrides:

toString in class IndexMetadata

Parameters:

sb - Where to write additional metadata.

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class IndexMetadata

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class IndexMetadata

Throws:

IOException

clone

public Stream.StreamIndexMetadata clone()

Description copied from class: IndexMetadata

Makes a copy of the persistent data, clearing the address of the IndexMetadata record on the cloned copy.

Overrides:

clone in class IndexMetadata

Returns:

The cloned copy.