org.apache.hadoop.hbase.client.tableindexed
Class IndexSpecification

java.lang.Object
  extended by org.apache.hadoop.hbase.client.tableindexed.IndexSpecification
All Implemented Interfaces:
org.apache.hadoop.io.Writable

public class IndexSpecification
extends Object
implements org.apache.hadoop.io.Writable

Holds the specification for a single secondary index.


Constructor Summary
IndexSpecification()
           
IndexSpecification(String indexId, byte[] indexedColumn)
          Construct an "simple" index spec for a single column.
IndexSpecification(String indexId, byte[][] indexedColumns, byte[][] additionalColumns, IndexKeyGenerator keyGenerator)
          Construct an index spec by specifying everything.
 
Method Summary
 boolean containsColumn(byte[] column)
           
 byte[][] getAdditionalColumns()
          Get the additionalColumns.
 byte[][] getAllColumns()
           
 byte[][] getIndexedColumns()
          Get the indexedColumns.
 byte[] getIndexedTableName(byte[] baseTableName)
           
 String getIndexId()
          Get the indexId.
 IndexKeyGenerator getKeyGenerator()
          Get the keyGenerator.
 void readFields(DataInput in)
          
 String toString()
          
 void write(DataOutput out)
          
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IndexSpecification

public IndexSpecification(String indexId,
                          byte[] indexedColumn)
Construct an "simple" index spec for a single column.

Parameters:
indexId -
indexedColumn -

IndexSpecification

public IndexSpecification(String indexId,
                          byte[][] indexedColumns,
                          byte[][] additionalColumns,
                          IndexKeyGenerator keyGenerator)
Construct an index spec by specifying everything.

Parameters:
indexId -
indexedColumns -
additionalColumns -
keyGenerator -

IndexSpecification

public IndexSpecification()
Method Detail

getIndexedColumns

public byte[][] getIndexedColumns()
Get the indexedColumns.

Returns:
Return the indexedColumns.

getKeyGenerator

public IndexKeyGenerator getKeyGenerator()
Get the keyGenerator.

Returns:
Return the keyGenerator.

getAdditionalColumns

public byte[][] getAdditionalColumns()
Get the additionalColumns.

Returns:
Return the additionalColumns.

getIndexId

public String getIndexId()
Get the indexId.

Returns:
Return the indexId.

getAllColumns

public byte[][] getAllColumns()

containsColumn

public boolean containsColumn(byte[] column)

getIndexedTableName

public byte[] getIndexedTableName(byte[] baseTableName)

readFields

public void readFields(DataInput in)
                throws IOException

Specified by:
readFields in interface org.apache.hadoop.io.Writable
Throws:
IOException

write

public void write(DataOutput out)
           throws IOException

Specified by:
write in interface org.apache.hadoop.io.Writable
Throws:
IOException

toString

public String toString()

Overrides:
toString in class Object


Copyright © 2010 The Apache Software Foundation