org.eclipse.soda.dk.random.access.file.connection
Class RandomAccessFileConnection

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.connection.Connection
          org.eclipse.soda.dk.random.access.file.connection.RandomAccessFileConnection

All Implemented Interfaces:

ConnectionService, RandomAccessFileConnectionService

public class RandomAccessFileConnection
extends Connection
implements RandomAccessFileConnectionService, ConnectionService

The RandomAccessFileConnection class implements the ConnectionService interface to support reading and writing to a random ascces file.

Version:

1.1.0

See Also:

ConnectionService, File

Field Summary

Fields inherited from class org.eclipse.soda.dk.connection.Connection

CLIENT_WAIT_RESOURCE, CLOSE_RESOURCE, CLOSED_RESOURCE, configurationService, OPEN_RESOURCE, OPENFAILED_RESOURCE, READ_BYTES_RESOURCE, readByteCount, WRITE_BYTES_RESOURCE, writeByteCount

Fields inherited from class org.eclipse.soda.dk.core.EscObject

CLONE_EXCEPTION_RESOURCE, EMPTY_BYTES, EMPTY_STRING, ERROR_OCCURRED_EXCEPTION_RESOURCE, ID_FILTER_KEY, ID_KEY, ID_KEY_ANY, INTEGER_TABLE, INTEGER_TABLE_SIZE, KEY_KEY, LOG_DEBUG, LOG_ERROR, LOG_INFO, LOG_TRACE, LOG_WARNING, PREFIX_KEY, RESOURCE_BUNDLE, SLEEP_EXCEPTION_RESOURCE, SYSTEM_INFO_RESOURCE, TO_STRING_CONFIGURATION_KEYS, TRACE_LEVEL_HIGH, TRACE_LEVEL_LOW, TRACE_LEVEL_MAX, TRACE_LEVEL_MIN, TRACE_LEVEL_NONE, TRACE_LEVEL_NORMAL, TRACELEVEL_KEY, UNKNOWN_ERROR_RESOURCE

Fields inherited from interface org.eclipse.soda.dk.random.access.file.connection.service.RandomAccessFileConnectionService

CONNECTION_TYPE, DEFAULT_MODE, DEFAULT_NAME, DEFAULT_PATH, FACTORY_SERVICE_NAME, MODE_KEY, NAME_KEY, PATH_KEY, SERVICE_NAME

Fields inherited from interface org.eclipse.soda.dk.connection.service.ConnectionService

CONNECTION_KEY, DEFAULT_CONNECTION

Constructor Summary

RandomAccessFileConnection()
Constructs a standard FileConnection object.

RandomAccessFileConnection(ConfigurationService configuration)
Constructs an instance of this class from the specified configuration parameter.

RandomAccessFileConnection(java.util.Dictionary properties)

RandomAccessFileConnection(java.io.RandomAccessFile randomAccessFile)
Constructs an RandomAccessFileConnection object using the input parameter(s).

RandomAccessFileConnection(java.lang.String path, java.lang.String filename, java.lang.String mode)

Method Summary

void	close() Perform the close action method.
void	exit() Exit.
java.io.RandomAccessFile	getRandomAccessFile() Gets the random access file value.
void	open() Perform the open action method.
int	read(byte[] bytes, int offset, int length) Read data into the bytes specified.
void	setRandomAccessFile(java.io.RandomAccessFile randomAccessFile) Sets the random access file value.
void	toStringInfo(java.lang.StringBuffer buffer) To string info with the specified buffer parameter.
void	write(byte[] bytes, int offset, int count) Writes count bytes from the byte array buffer starting at offset.

Methods inherited from class org.eclipse.soda.dk.connection.Connection

attemptRecoveryFromError, finalize, flush, getConfigurationService, getDefaultResource, getErrorSeverity, getLogDetails4, getLogDetails5, getReadByteCount, getResource, getWriteByteCount, isOpen, read, setConfigurationService, setOpen, setReadByteCount, setWriteByteCount, updateReadByteCount, updateWriteByteCount, write

Methods inherited from class org.eclipse.soda.dk.core.EscObject

createDefaultLogService, createException, createException, createInteger, createIntegerTable, createNumber, format, getBoolean, getCurrentTimestamp, getDefaultLogService, getFloat, getInt, getLoadLibraryName, getLogDetails, getLogDetails0, getLogDetails1, getLogDetails2, getLogDetails3, getLogDetails6, getLogDetails7, getLogService, getLong, getObject, getOutputName, getSimpleClassName, getStaticBoolean, getStaticFloat, getStaticInt, getStaticLong, getStaticObject, getStaticString, getString, getTraceLevel, getVmLibraryVersion, handleError, handleError, handleError, handleErrorInternal, handleStaticError, handleStaticException, isDebug, isTrace, loadService, log, log, report, report, report, report, report, report, reportError, reportSystemInfo, setDebug, setDefaultLogService, setLogService, setTraceLevel, shouldLog, sleep, startupEscStatic, toString, toStringConfigurationKeys

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.soda.dk.connection.service.ConnectionService

flush, isOpen, read, write

Constructor Detail

RandomAccessFileConnection

public RandomAccessFileConnection()

Constructs a standard FileConnection object. This constructor uses the default input and output names.

See Also:

RandomAccessFileConnection(RandomAccessFile), RandomAccessFileConnection(String,String,String), RandomAccessFileConnection(Dictionary), RandomAccessFileConnection(ConfigurationService)

RandomAccessFileConnection

public RandomAccessFileConnection(java.io.RandomAccessFile randomAccessFile)

Constructs an RandomAccessFileConnection object using the input parameter(s). java.io.RandomAccessFile The random access file (RandomAccessFile) parameter.

Parameters:

randomAccessFile - The random access file (RandomAccessFile) parameter.

See Also:

RandomAccessFileConnection(), RandomAccessFileConnection(String,String,String), RandomAccessFileConnection(Dictionary), RandomAccessFileConnection(ConfigurationService)

RandomAccessFileConnection

public RandomAccessFileConnection(java.lang.String path,
                                  java.lang.String filename,
                                  java.lang.String mode)

Parameters:

path - The path (String) parameter.

filename - The filename (String) parameter.

mode - The mode (String) parameter.

See Also:

RandomAccessFileConnection(), RandomAccessFileConnection(RandomAccessFile), RandomAccessFileConnection(Dictionary), RandomAccessFileConnection(ConfigurationService)

RandomAccessFileConnection

public RandomAccessFileConnection(java.util.Dictionary properties)

Parameters:

properties - The properties (Dictionary) parameter.

See Also:

RandomAccessFileConnection(), RandomAccessFileConnection(RandomAccessFile), RandomAccessFileConnection(String,String,String), RandomAccessFileConnection(ConfigurationService)

RandomAccessFileConnection

public RandomAccessFileConnection(ConfigurationService configuration)

Constructs an instance of this class from the specified configuration parameter. The configuration (ConfigurationService) parameter.

Parameters:

configuration - The configuration (ConfigurationService) parameter.

See Also:

RandomAccessFileConnection(), RandomAccessFileConnection(RandomAccessFile), RandomAccessFileConnection(String,String,String), RandomAccessFileConnection(Dictionary)

Method Detail

close

public void close()
           throws java.io.IOException

Perform the close action method.

Specified by:

close in interface ConnectionService

Overrides:

close in class Connection

Throws:

java.io.IOException - IOException.

See Also:

ConnectionService.close()

exit

public void exit()
          throws java.io.IOException

Exit.

Specified by:

exit in interface ConnectionService

Overrides:

exit in class Connection

Throws:

java.io.IOException - IOException.

getRandomAccessFile

public java.io.RandomAccessFile getRandomAccessFile()

Gets the random access file value.

Returns:

The random access file (RandomAccessFile) value.

See Also:

setRandomAccessFile(RandomAccessFile)

open

public void open()
          throws java.io.IOException

Perform the open action method. href="java.io.IOException.html">IOException Thrown if the IOException exception condition occurs.

Specified by:

open in interface ConnectionService

Overrides:

open in class Connection

Throws:

java.io.IOException - IOException.

See Also:

ConnectionService.open()

read

public int read(byte[] bytes,
                int offset,
                int length)
         throws java.io.IOException

Description copied from interface: ConnectionService

Read data into the bytes specified. the byte array in which to store the read bytes. the offset in b to store the read bytes. the maximum number of bytes to store in b.

Specified by:

read in interface ConnectionService

Parameters:

bytes - The bytes (byte[]) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

Returns:

Results of the read (int) value.

Throws:

java.io.IOException - IOException.

See Also:

ConnectionService.read(byte[])

setRandomAccessFile

public void setRandomAccessFile(java.io.RandomAccessFile randomAccessFile)

Sets the random access file value. The random access file (RandomAccessFile) parameter.

Parameters:

randomAccessFile - The random access file (RandomAccessFile) parameter.

See Also:

getRandomAccessFile()

toStringInfo

public void toStringInfo(java.lang.StringBuffer buffer)

Description copied from class: Connection

To string info with the specified buffer parameter.

Overrides:

toStringInfo in class Connection

Parameters:

buffer - The buffer (StringBuffer) parameter.

write

public void write(byte[] bytes,
                  int offset,
                  int count)
           throws java.io.IOException

Description copied from interface: ConnectionService

Writes count bytes from the byte array buffer starting at offset. the buffer to be written offset in buffer to get bytes number of bytes in buffer to write an error occurs attempting to write to this OutputStream. If offset or count are outside of bounds.

Specified by:

write in interface ConnectionService

Parameters:

bytes - The bytes (byte[]) parameter.

offset - The offset (int) parameter.

count - The count (int) parameter.

Throws:

java.io.IOException - IOException.

See Also:

ConnectionService.write(byte[])