org.apache.hadoop.hbase.regionserver

Class StoreFileInfo

java.lang.Object

org.apache.hadoop.hbase.regionserver.StoreFileInfo

@InterfaceAudience.Private
public class StoreFileInfo
extends Object

Describe a StoreFile (hfile, reference, link)

Field Summary

Fields

Modifier and Type	Field and Description
static String	HFILE_NAME_REGEX A non-capture group, for hfiles, so that this can be embedded.
static org.apache.commons.logging.Log	LOG

Constructor Summary

Constructors

Constructor and Description
StoreFileInfo(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.FileStatus fileStatus) Create a Store File Info
StoreFileInfo(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.FileStatus fileStatus, HFileLink link) Create a Store File Info from an HFileLink
StoreFileInfo(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.FileStatus fileStatus, Reference reference) Create a Store File Info from an HFileLink
StoreFileInfo(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path initialPath) Create a Store File Info

Method Summary

Methods

Modifier and Type	Method and Description
HDFSBlocksDistribution	computeHDFSBlocksDistribution(org.apache.hadoop.fs.FileSystem fs) Compute the HDFS Block Distribution for this StoreFile
boolean	equals(Object that)
org.apache.hadoop.fs.FileStatus	getFileStatus()
HDFSBlocksDistribution	getHDFSBlockDistribution()
long	getModificationTime()
org.apache.hadoop.fs.Path	getPath()
Reference	getReference()
org.apache.hadoop.fs.FileStatus	getReferencedFileStatus(org.apache.hadoop.fs.FileSystem fs) Get the FileStatus of the file referenced by this StoreFileInfo
static org.apache.hadoop.fs.Path	getReferredToFile(org.apache.hadoop.fs.Path p)
int	hashCode()
static boolean	isHFile(org.apache.hadoop.fs.Path path)
static boolean	isHFile(String fileName)
boolean	isLink()
boolean	isReference()
static boolean	isReference(org.apache.hadoop.fs.Path path)
static boolean	isReference(String name)
boolean	isTopReference()
static boolean	isValid(org.apache.hadoop.fs.FileStatus fileStatus) Return if the specified file is a valid store file or not.
StoreFile.Reader	open(org.apache.hadoop.fs.FileSystem fs, CacheConfig cacheConf) Open a Reader for the StoreFile
void	setRegionCoprocessorHost(RegionCoprocessorHost coprocessorHost) Sets the region coprocessor env.
String	toString()
static boolean	validateStoreFileName(String fileName) Validate the store file name.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

LOG

public static final org.apache.commons.logging.Log LOG

HFILE_NAME_REGEX

public static final String HFILE_NAME_REGEX

A non-capture group, for hfiles, so that this can be embedded. HFiles are uuid ([0-9a-z]+). Bulk loaded hfiles has (_SeqId_[0-9]+_) has suffix.

See Also:

Constant Field Values

Constructor Detail

StoreFileInfo

public StoreFileInfo(org.apache.hadoop.conf.Configuration conf,
             org.apache.hadoop.fs.FileSystem fs,
             org.apache.hadoop.fs.Path initialPath)
              throws IOException

Create a Store File Info

Parameters:

conf - the Configuration to use

fs - The current file system to use.

initialPath - The Path of the file

Throws:

IOException

StoreFileInfo

public StoreFileInfo(org.apache.hadoop.conf.Configuration conf,
             org.apache.hadoop.fs.FileSystem fs,
             org.apache.hadoop.fs.FileStatus fileStatus)
              throws IOException

Create a Store File Info

Parameters:

conf - the Configuration to use

fs - The current file system to use.

fileStatus - The FileStatus of the file

Throws:

IOException

StoreFileInfo

public StoreFileInfo(org.apache.hadoop.conf.Configuration conf,
             org.apache.hadoop.fs.FileSystem fs,
             org.apache.hadoop.fs.FileStatus fileStatus,
             HFileLink link)
              throws IOException

Create a Store File Info from an HFileLink

Parameters:

conf - the Configuration to use

fs - The current file system to use.

fileStatus - The FileStatus of the file

Throws:

IOException

StoreFileInfo

public StoreFileInfo(org.apache.hadoop.conf.Configuration conf,
             org.apache.hadoop.fs.FileSystem fs,
             org.apache.hadoop.fs.FileStatus fileStatus,
             Reference reference)
              throws IOException

Create a Store File Info from an HFileLink

Parameters:

conf -

fs -

fileStatus -

reference -

Throws:

IOException

Method Detail

setRegionCoprocessorHost

public void setRegionCoprocessorHost(RegionCoprocessorHost coprocessorHost)

Sets the region coprocessor env.

Parameters:

coprocessorHost -

getReference

public Reference getReference()

isReference

public boolean isReference()

Returns:

True if the store file is a Reference

isTopReference

public boolean isTopReference()

Returns:

True if the store file is a top Reference

isLink

public boolean isLink()

Returns:

True if the store file is a link

getHDFSBlockDistribution

public HDFSBlocksDistribution getHDFSBlockDistribution()

Returns:

the HDFS block distribution

open

public StoreFile.Reader open(org.apache.hadoop.fs.FileSystem fs,
                    CacheConfig cacheConf)
                      throws IOException

Open a Reader for the StoreFile

Parameters:

fs - The current file system to use.

cacheConf - The cache configuration and block cache reference.

Returns:

The StoreFile.Reader for the file

Throws:

IOException

computeHDFSBlocksDistribution

public HDFSBlocksDistribution computeHDFSBlocksDistribution(org.apache.hadoop.fs.FileSystem fs)
                                                     throws IOException

Compute the HDFS Block Distribution for this StoreFile

Throws:

IOException

getReferencedFileStatus

public org.apache.hadoop.fs.FileStatus getReferencedFileStatus(org.apache.hadoop.fs.FileSystem fs)
                                                        throws IOException

Get the FileStatus of the file referenced by this StoreFileInfo

Parameters:

fs - The current file system to use.

Returns:

The FileStatus of the file referenced by this StoreFileInfo

Throws:

IOException

getPath

public org.apache.hadoop.fs.Path getPath()

Returns:

The Path of the file

getFileStatus

public org.apache.hadoop.fs.FileStatus getFileStatus()
                                              throws IOException

Returns:

The FileStatus of the file

Throws:

IOException

getModificationTime

public long getModificationTime()
                         throws IOException

Returns:

Get the modification time of the file.

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

isHFile

public static boolean isHFile(org.apache.hadoop.fs.Path path)

Parameters:

path - Path to check.

Returns:

True if the path has format of a HFile.

isHFile

public static boolean isHFile(String fileName)

isReference

public static boolean isReference(org.apache.hadoop.fs.Path path)

Parameters:

path - Path to check.

Returns:

True if the path has format of a HStoreFile reference.

isReference

public static boolean isReference(String name)

Parameters:

name - file name to check.

Returns:

True if the path has format of a HStoreFile reference.

getReferredToFile

public static org.apache.hadoop.fs.Path getReferredToFile(org.apache.hadoop.fs.Path p)

validateStoreFileName

public static boolean validateStoreFileName(String fileName)

Validate the store file name.

Parameters:

fileName - name of the file to validate

Returns:

true if the file could be a valid store file, false otherwise

isValid

public static boolean isValid(org.apache.hadoop.fs.FileStatus fileStatus)
                       throws IOException

Return if the specified file is a valid store file or not.

Parameters:

fileStatus - The FileStatus of the file

Returns:

true if the file is valid

Throws:

IOException

equals

public boolean equals(Object that)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object