org.eclipse.scada.hds

Class DataFileAccessorImpl

java.lang.Object

org.eclipse.scada.hds.DataFileAccessorImpl

All Implemented Interfaces:

DataFileAccessor

public class DataFileAccessorImpl
extends java.lang.Object
implements DataFileAccessor

Field Summary

Fields

Modifier and Type	Field and Description
protected java.nio.channels.FileChannel	channel
protected java.util.Date	end
protected java.io.RandomAccessFile	file
protected static byte	FLAG_DELETED
protected static byte	FLAG_ERROR
protected static byte	FLAG_HEARTBEAT
protected static byte	FLAG_MANUAL
protected static int	HEADER_SIZE
protected java.util.Date	start

Constructor Summary

Constructors

Constructor and Description
DataFileAccessorImpl(java.io.File file)

Method Summary

Methods

Modifier and Type	Method and Description
static DataFileAccessorImpl	create(java.io.File file, java.util.Date startDate, java.util.Date endDate) Initialize a new file, write the empty structure to disk and return a new accessor to it
void	delete() Dispose and delete the file
void	dispose() Dispose the file.
void	forwardCorrect(double value, java.util.Date timestamp, boolean error, boolean manual) Forward correct entries
java.util.Date	getEnd()
java.util.Date	getStart()
void	insertValue(double value, java.util.Date date, boolean error, boolean manual, boolean heartbeat)
boolean	visit(ValueVisitor visitor)
boolean	visitFirstValue(ValueVisitor visitor)

Methods inherited from class java.lang.Object

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

Field Detail

FLAG_DELETED

protected static final byte FLAG_DELETED

See Also:

Constant Field Values

FLAG_HEARTBEAT

protected static final byte FLAG_HEARTBEAT

See Also:

Constant Field Values

FLAG_MANUAL

protected static final byte FLAG_MANUAL

See Also:

Constant Field Values

FLAG_ERROR

protected static final byte FLAG_ERROR

See Also:

Constant Field Values

HEADER_SIZE

protected static final int HEADER_SIZE

See Also:

Constant Field Values

file

protected java.io.RandomAccessFile file

channel

protected final java.nio.channels.FileChannel channel

start

protected java.util.Date start

end

protected java.util.Date end

Constructor Detail

DataFileAccessorImpl

public DataFileAccessorImpl(java.io.File file)
                     throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

getStart

public java.util.Date getStart()

Specified by:

getStart in interface DataFileAccessor

getEnd

public java.util.Date getEnd()

Specified by:

getEnd in interface DataFileAccessor

insertValue

public void insertValue(double value,
               java.util.Date date,
               boolean error,
               boolean manual,
               boolean heartbeat)
                 throws java.io.IOException

Specified by:

insertValue in interface DataFileAccessor

Throws:

java.io.IOException

visitFirstValue

public boolean visitFirstValue(ValueVisitor visitor)
                        throws java.lang.Exception

Specified by:

visitFirstValue in interface DataFileAccessor

Throws:

java.lang.Exception

visit

public boolean visit(ValueVisitor visitor)
              throws java.io.IOException

Specified by:

visit in interface DataFileAccessor

Throws:

java.io.IOException

forwardCorrect

public void forwardCorrect(double value,
                  java.util.Date timestamp,
                  boolean error,
                  boolean manual)
                    throws java.lang.Exception

Description copied from interface: DataFileAccessor

Forward correct entries

Specified by:

forwardCorrect in interface DataFileAccessor

Parameters:

value - the value

timestamp - the starting point

error - the error flag

manual - the manual flag

Throws:

java.lang.Exception

dispose

public void dispose()

Dispose the file. Close all resources.

Specified by:

dispose in interface DataFileAccessor

delete

public void delete()

Dispose and delete the file

Specified by:

delete in interface DataFileAccessor

create

public static DataFileAccessorImpl create(java.io.File file,
                          java.util.Date startDate,
                          java.util.Date endDate)
                                   throws java.lang.Exception

Initialize a new file, write the empty structure to disk and return a new accessor to it

Parameters:

file - The file to create. This file must not exists.

startDate - the start date of the file

endDate - the end date of the file

Returns:

a newly created file accessor

Throws:

java.lang.Exception - if anything goes wrong