org.processmining.BigData.common.GraphManagement.XES2Graph.virtual.utils

Class VirtualFileInputStream

java.lang.Object

java.io.InputStream

java.io.FileInputStream

org.processmining.BigData.common.GraphManagement.XES2Graph.virtual.utils.VirtualFileInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class VirtualFileInputStream
extends java.io.FileInputStream

An extension of the FileInputStream class to access to specific chunks of bytes from a file. Several chunks inside the same file can be defined to create the virtual file. Chunks should be disjointed. If not, the behavior is undefined. The code is adapted from the FileInputStream class

Author:

Sergio Hernandez

Constructor Summary

Constructors

Constructor and Description
VirtualFileInputStream(java.io.FileDescriptor fdObj, long[] start, long[] end) Creates a VirtualFileInputStream by using the file descriptor fdObj, which represents an existing connection to an actual file in the file system.
VirtualFileInputStream(java.io.File file, long[] start, long[] end) Creates a VirtualFileInputStream by opening a connection to an actual file, the file named by the File object file in the file system.
VirtualFileInputStream(java.lang.String name, long[] start, long[] end) Creates a VitualFileInputStream by opening a connection to an actual file, the file named by the path name name in the file system.

Method Summary

Methods

Modifier and Type	Method and Description
int	available() Returns an estimate of the number of remaining bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream.
int	read() Reads a byte of data from this input stream.
int	read(byte[] b) Reads up to b.length bytes of data from this input stream into an array of bytes.
int	read(byte[] b, int off, int len) Reads up to len bytes of data from this input stream into an array of bytes.
long	skip(long n) Skips over and discards n bytes of data from the input stream.

Methods inherited from class java.io.FileInputStream

close, finalize, getChannel, getFD

Methods inherited from class java.io.InputStream

mark, markSupported, reset

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VirtualFileInputStream

public VirtualFileInputStream(java.lang.String name,
                      long[] start,
                      long[] end)
                       throws java.io.IOException

Creates a VitualFileInputStream by opening a connection to an actual file, the file named by the path name name in the file system. A new FileDescriptor object is created to represent this file connection.

First, if there is a security manager, its checkRead method is called with the name argument as its argument.

If the named file does not exist, is a directory rather than a regular file, or for some other reason cannot be opened for reading then a FileNotFoundException is thrown.

Parameters:

name - the system-dependent file name.

start - Split start

end - Split end

Throws:

java.io.IOException - If an I/O error has occurred.

java.lang.SecurityException - if a security manager exists and its checkRead method denies read access to the file.

See Also:

SecurityManager.checkRead(java.lang.String)

VirtualFileInputStream

public VirtualFileInputStream(java.io.File file,
                      long[] start,
                      long[] end)
                       throws java.io.IOException

Creates a VirtualFileInputStream by opening a connection to an actual file, the file named by the File object file in the file system. A new FileDescriptor object is created to represent this file connection.

First, if there is a security manager, its checkRead method is called with the path represented by the file argument as its argument.

If the named file does not exist, is a directory rather than a regular file, or for some other reason cannot be opened for reading then a FileNotFoundException is thrown.

Parameters:

file - the file to be opened for reading.

start - Split start

end - Split end

Throws:

java.io.IOException

java.lang.SecurityException - if a security manager exists and its checkRead method denies read access to the file.

See Also:

File.getPath(), SecurityManager.checkRead(java.lang.String)

VirtualFileInputStream

public VirtualFileInputStream(java.io.FileDescriptor fdObj,
                      long[] start,
                      long[] end)
                       throws java.io.IOException

Creates a VirtualFileInputStream by using the file descriptor fdObj, which represents an existing connection to an actual file in the file system.

If there is a security manager, its checkRead method is called with the file descriptor fdObj as its argument to see if it's ok to read the file descriptor. If read access is denied to the file descriptor a SecurityException is thrown.

If fdObj is null then a NullPointerException is thrown.

Parameters:

fdObj - the file descriptor to be opened for reading.

start - Split start

end - Split end

Throws:

java.io.IOException

java.lang.SecurityException - if a security manager exists and its checkRead method denies read access to the file descriptor.

See Also:

SecurityManager.checkRead(java.io.FileDescriptor)

Method Detail

read

public int read()
         throws java.io.IOException

Reads a byte of data from this input stream. This method blocks if no input is yet available.

Overrides:

read in class java.io.FileInputStream

Returns:

the next byte of data, or -1 if the end of the file is reached.

Throws:

java.io.IOException - if an I/O error occurs.

read

public int read(byte[] b)
         throws java.io.IOException

Reads up to b.length bytes of data from this input stream into an array of bytes. This method blocks until some input is available.

Overrides:

read in class java.io.FileInputStream

Parameters:

b - the buffer into which the data is read.

Returns:

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the file has been reached.

Throws:

java.io.IOException - if an I/O error occurs.

read

public int read(byte[] b,
       int off,
       int len)
         throws java.io.IOException

Reads up to len bytes of data from this input stream into an array of bytes. If len is not zero, the method blocks until some input is available; otherwise, no bytes are read and 0 is returned.

Overrides:

read in class java.io.FileInputStream

Parameters:

b - the buffer into which the data is read.

off - the start offset in the destination array b

len - the maximum number of bytes read.

Returns:

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the file has been reached.

Throws:

java.lang.NullPointerException - If b is null.

java.lang.IndexOutOfBoundsException - If off is negative, len is negative, or len is greater than b.length - off

java.io.IOException - if an I/O error occurs.

skip

public long skip(long n)
          throws java.io.IOException

Skips over and discards n bytes of data from the input stream.

The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. If n is negative, an IOException is thrown, even though the skip method of the InputStream superclass does nothing in this case. The actual number of bytes skipped is returned.

This method may skip more bytes than are remaining in the backing file. This produces no exception and the number of bytes skipped may include some number of bytes that were beyond the EOF of the backing file. Attempting to read from the stream after skipping past the end will result in -1 indicating the end of the file.

Overrides:

skip in class java.io.FileInputStream

Parameters:

n - the number of bytes to be skipped.

Returns:

the actual number of bytes skipped.

Throws:

java.io.IOException - if n is negative, if the stream does not support seek, or if an I/O error occurs.

available

public int available()
              throws java.io.IOException

Returns an estimate of the number of remaining bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream. The next invocation might be the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.

In some cases, a non-blocking read (or skip) may appear to be blocked when it is merely slow, for example when reading large files over slow networks.

Overrides:

available in class java.io.FileInputStream

Returns:

an estimate of the number of remaining bytes that can be read (or skipped over) from this input stream without blocking.

Throws:

java.io.IOException - if this file input stream has been closed by calling close or an I/O error occurs.