TachyonFile (Tachyon Project Core 0.6.4 API)

java.lang.Object
- tachyon.client.TachyonFile

All Implemented Interfaces:: Comparable<TachyonFile>

public class TachyonFile
extends Object
implements Comparable<TachyonFile>

Tachyon File.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(TachyonFile o)`
`boolean`	`equals(Object obj)`
`long`	`getBlockId(int blockIndex)` Return the block id of a block in the file, specified by blockIndex
`long`	`getBlockSizeByte()` Return the block's size of this file
`ClientBlockInfo`	`getClientBlockInfo(int blockIndex)` Get a ClientBlockInfo by the file id and block index
`long`	`getCreationTimeMs()` Return the creation time of this file
`int`	`getDiskReplication()`
`InStream`	`getInStream(ReadType readType)` Return the InStream of this file, use the specified read type.
`String`	`getLocalFilename(int blockIndex)` Returns the local filename for the block if that file exists on the local file system.
`List<String>`	`getLocationHosts()` Return the net address of all the location hosts
`int`	`getNumberOfBlocks()` Return the number of blocks the file has.
`OutStream`	`getOutStream(WriteType writeType)` Return the OutStream of this file, use the specified write type.
`String`	`getPath()` Return the path of this file in the Tachyon file system
`Object`	`getUFSConf()` To get the configuration object for UnderFileSystem.
`int`	`hashCode()`
`boolean`	`isComplete()` Return whether this file is complete or not
`boolean`	`isDirectory()`
`boolean`	`isFile()`
`boolean`	`isInMemory()` Return whether the file is in memory or not.
`long`	`length()`
`boolean`	`needPin()`
`boolean`	`promoteBlock(int blockIndex)` Promote block back to top layer after access
`TachyonByteBuffer`	`readByteBuffer(int blockIndex)` Advanced API.
`boolean`	`recache()`
`boolean`	`rename(TachyonURI path)` Rename this file
`void`	`setUFSConf(Object conf)` To set the configuration object for UnderFileSystem.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - compareTo
```
public int compareTo(TachyonFile o)
```
    Specified by:
    
    compareTo in interface Comparable<TachyonFile>
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getBlockId
```
public long getBlockId(int blockIndex)
                throws IOException
```
    Return the block id of a block in the file, specified by blockIndex
    
    Parameters:
    blockIndex - the index of the block in this file
    
    Returns:
    the block id
    
    Throws:
    
    IOException
  - getBlockSizeByte
```
public long getBlockSizeByte()
                      throws IOException
```
    Return the block's size of this file
    
    Returns:
    the block's size in bytes
    
    Throws:
    
    IOException
  - getClientBlockInfo
```
public ClientBlockInfo getClientBlockInfo(int blockIndex)
                                   throws IOException
```
    Get a ClientBlockInfo by the file id and block index
    
    Parameters:
    blockIndex - The index of the block in the file.
    
    Returns:
    the ClientBlockInfo of the specified block
    
    Throws:
    
    IOException
  - getCreationTimeMs
```
public long getCreationTimeMs()
                       throws IOException
```
    Return the creation time of this file
    
    Returns:
    the creation time, in milliseconds
    
    Throws:
    
    IOException
  - getDiskReplication
```
public int getDiskReplication()
```
  - getInStream
```
public InStream getInStream(ReadType readType)
                     throws IOException
```
    Return the InStream of this file, use the specified read type. If it has no block, return an EmptyBlockInStream. Else if it has only one block ,return a BlockInStream of the block. Else, return a FileInStream.
    
    Parameters:
    readType - the InStream's read type
    
    Returns:
    the InStream
    
    Throws:
    
    IOException
  - getLocalFilename
```
public String getLocalFilename(int blockIndex)
                        throws IOException
```
    Returns the local filename for the block if that file exists on the local file system. This is an alpha power-api feature for applications that want short-circuit-read files directly. There is no guarantee that the file still exists after this call returns, as Tachyon may evict blocks from memory at any time.
    
    Parameters:
    blockIndex - The index of the block in the file.
    
    Returns:
    filename on local file system or null if file not present on local file system.
    
    Throws:
    
    IOException
  - getLocationHosts
```
public List<String> getLocationHosts()
                              throws IOException
```
    Return the net address of all the location hosts
    
    Returns:
    the list of those net address, in String
    
    Throws:
    
    IOException
  - getNumberOfBlocks
```
public int getNumberOfBlocks()
                      throws IOException
```
    Return the number of blocks the file has.
    
    Returns:
    the number of blocks
    
    Throws:
    
    IOException
  - getOutStream
```
public OutStream getOutStream(WriteType writeType)
                       throws IOException
```
    Return the OutStream of this file, use the specified write type. Always return a FileOutStream.
    
    Parameters:
    writeType - the OutStream's write type
    
    Returns:
    the OutStream
    
    Throws:
    
    IOException
  - getPath
```
public String getPath()
               throws IOException
```
    Return the path of this file in the Tachyon file system
    
    Returns:
    the path
    
    Throws:
    
    IOException
  - getUFSConf
```
public Object getUFSConf()
```
    To get the configuration object for UnderFileSystem.
    
    Returns:
    configuration object used for concrete ufs instance
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - isComplete
```
public boolean isComplete()
                   throws IOException
```
    Return whether this file is complete or not
    
    Returns:
    true if this file is complete, false otherwise
    
    Throws:
    
    IOException
  - isDirectory
```
public boolean isDirectory()
                    throws IOException
```
    Returns:
    true if this is a directory, false otherwise
    
    Throws:
    
    IOException
  - isFile
```
public boolean isFile()
               throws IOException
```
    Returns:
    true if this is a file, false otherwise
    
    Throws:
    
    IOException
  - isInMemory
```
public boolean isInMemory()
                   throws IOException
```
    Return whether the file is in memory or not. Note that a file may be partly in memory. This value is true only if the file is fully in memory.
    
    Returns:
    true if the file is fully in memory, false otherwise
    
    Throws:
    
    IOException
  - length
```
public long length()
            throws IOException
```
    Returns:
    the file size in bytes
    
    Throws:
    
    IOException
  - needPin
```
public boolean needPin()
                throws IOException
```
    Returns:
    true if this file is pinned, false otherwise
    
    Throws:
    
    IOException
  - promoteBlock
```
public boolean promoteBlock(int blockIndex)
                     throws IOException
```
    Promote block back to top layer after access
    
    Parameters:
    blockIndex - the index of the block
    
    Returns:
    true if success, false otherwise
    
    Throws:
    
    IOException
  - readByteBuffer
```
public TachyonByteBuffer readByteBuffer(int blockIndex)
                                 throws IOException
```
    Advanced API. Return a TachyonByteBuffer of the block specified by the blockIndex
    
    Parameters:
    blockIndex - The block index of the current file to read.
    
    Returns:
    TachyonByteBuffer containing the block.
    
    Throws:
    
    IOException
  - recache
```
public boolean recache()
                throws IOException
```
    Throws:
    
    IOException
  - rename
```
public boolean rename(TachyonURI path)
               throws IOException
```
    Rename this file
    
    Parameters:
    path - the new name
    
    Returns:
    true if succeed, false otherwise
    
    Throws:
    
    IOException
  - setUFSConf
```
public void setUFSConf(Object conf)
```
    To set the configuration object for UnderFileSystem. The conf object is understood by the concrete underfs' implementation.
    
    Parameters:
    conf - The configuration object accepted by ufs.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class TachyonFile

Method Summary

Methods inherited from class java.lang.Object

Method Detail

compareTo

equals

getBlockId

getBlockSizeByte

getClientBlockInfo

getCreationTimeMs

getDiskReplication

getInStream

getLocalFilename

getLocationHosts

getNumberOfBlocks

getOutStream

getPath

getUFSConf

hashCode

isComplete

isDirectory

isFile

isInMemory

length

needPin

promoteBlock

readByteBuffer

recache

rename

setUFSConf

toString