StoreFile (Apache HBase 2.3.0 API)

All Known Implementing Classes:

HStoreFile
```
@InterfaceAudience.LimitedPrivate(value="Coprocesssor")
 @InterfaceStability.Evolving
public interface StoreFile
```
An interface to describe a store data file.
NOTICE: this interface is mainly designed for coprocessor, so it will not expose all the internal APIs for a 'store file'. If you are implementing something inside HBase, i.e, not a coprocessor hook, usually you should use HStoreFile directly as it is the only implementation of this interface.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`excludeFromMinorCompaction()`
`OptionalLong`	`getBulkLoadTimestamp()` Return the timestamp at which this bulk load file was generated.
`CellComparator`	`getComparator()` Get the comparator for comparing two cells.
`org.apache.hadoop.fs.Path`	`getEncodedPath()`
`Optional<Cell>`	`getFirstKey()` Get the first key in this store file.
`Optional<Cell>`	`getLastKey()` Get the last key in this store file.
`OptionalLong`	`getMaximumTimestamp()` Get the max timestamp of all the cells in the store file.
`long`	`getMaxMemStoreTS()` Get max of the MemstoreTS in the KV's in this store file.
`long`	`getMaxSequenceId()`
`OptionalLong`	`getMinimumTimestamp()` Get the min timestamp of all the cells in the store file.
`long`	`getModificationTimestamp()` Get the modification time of this store file.
`long`	`getModificationTimeStamp()` Deprecated. Since 2.0.0. Will be removed in 3.0.0.
`org.apache.hadoop.fs.Path`	`getPath()`
`org.apache.hadoop.fs.Path`	`getQualifiedPath()`
`boolean`	`isBulkLoadResult()` Check if this storefile was created by bulk load.
`boolean`	`isHFile()`
`boolean`	`isMajorCompactionResult()`
`boolean`	`isReference()`
`String`	`toStringDetailed()`

- Method Detail
  - getFirstKey
```
Optional<Cell> getFirstKey()
```
    Get the first key in this store file.
  - getLastKey
```
Optional<Cell> getLastKey()
```
    Get the last key in this store file.
  - getComparator
```
CellComparator getComparator()
```
    Get the comparator for comparing two cells.
  - getMaxMemStoreTS
```
long getMaxMemStoreTS()
```
    Get max of the MemstoreTS in the KV's in this store file.
  - getPath
```
org.apache.hadoop.fs.Path getPath()
```
    Returns:
    
    Path or null if this StoreFile was made with a Stream.
  - getEncodedPath
```
org.apache.hadoop.fs.Path getEncodedPath()
```
    Returns:
    
    Encoded Path if this StoreFile was made with a Stream.
  - getQualifiedPath
```
org.apache.hadoop.fs.Path getQualifiedPath()
```
    Returns:
    
    Returns the qualified path of this StoreFile
  - isReference
```
boolean isReference()
```
    Returns:
    
    True if this is a StoreFile Reference.
  - isHFile
```
boolean isHFile()
```
    Returns:
    
    True if this is HFile.
  - isMajorCompactionResult
```
boolean isMajorCompactionResult()
```
    Returns:
    
    True if this file was made by a major compaction.
  - excludeFromMinorCompaction
```
boolean excludeFromMinorCompaction()
```
    Returns:
    
    True if this file should not be part of a minor compaction.
  - getMaxSequenceId
```
long getMaxSequenceId()
```
    Returns:
    
    This files maximum edit sequence id.
  - getModificationTimeStamp
```
@Deprecated
long getModificationTimeStamp()
                                   throws IOException
```
    Deprecated. Since 2.0.0. Will be removed in 3.0.0.
    
    Get the modification time of this store file. Usually will access the file system so throws IOException.
    
    Throws:
    
    IOException
    
    See Also:
    
    getModificationTimestamp()
  - getModificationTimestamp
```
long getModificationTimestamp()
                       throws IOException
```
    Get the modification time of this store file. Usually will access the file system so throws IOException.
    
    Throws:
    
    IOException
  - isBulkLoadResult
```
boolean isBulkLoadResult()
```
    Check if this storefile was created by bulk load. When a hfile is bulk loaded into HBase, we append '_SeqId_<id-when-loaded>' to the hfile name, unless "hbase.mapreduce.bulkload.assign.sequenceNumbers" is explicitly turned off. If "hbase.mapreduce.bulkload.assign.sequenceNumbers" is turned off, fall back to BULKLOAD_TIME_KEY.
    
    Returns:
    
    true if this storefile was created by bulk load.
  - getBulkLoadTimestamp
```
OptionalLong getBulkLoadTimestamp()
```
    Return the timestamp at which this bulk load file was generated.
  - toStringDetailed
```
String toStringDetailed()
```
    Returns:
    
    a length description of this StoreFile, suitable for debug output
  - getMinimumTimestamp
```
OptionalLong getMinimumTimestamp()
```
    Get the min timestamp of all the cells in the store file.
  - getMaximumTimestamp
```
OptionalLong getMaximumTimestamp()
```
    Get the max timestamp of all the cells in the store file.

Interface StoreFile

Method Summary

Method Detail

getFirstKey

getLastKey

getComparator

getMaxMemStoreTS

getPath

getEncodedPath

getQualifiedPath

isReference

isHFile

isMajorCompactionResult

excludeFromMinorCompaction

getMaxSequenceId

getModificationTimeStamp

getModificationTimestamp

isBulkLoadResult

getBulkLoadTimestamp

toStringDetailed

getMinimumTimestamp

getMaximumTimestamp