ambit2.core.io

Class FileState

java.lang.Object

ambit2.core.io.FileState

All Implemented Interfaces:

IInputOutputState, Serializable

Direct Known Subclasses:

FileInputState, FileOutputState

public class FileState
extends Object
implements IInputOutputState

This is to be able to verify if a file has changed since it has been last processed by FileBatchProcessing

Author:

Nina Jeliazkova Modified 2015-10-31

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileState._FILE_TYPE

Field Summary

Fields

Modifier and Type	Field and Description
protected long	currentRecord
protected String[]	extensionDescriptions
protected File	file
protected org.openscience.cdk.io.formats.IChemFormat	fileFormat
protected String	filename
protected int	hashCode
protected long	lastModified
protected long	length
protected static String	MSG_CANTCREATEFILE
protected static String	MSG_ERRORSAVE
protected static String	MSG_FILEDONOTEXISTS
protected static String	MSG_OPEN
protected static String	MSG_UNSUPPORTEDFORMAT
protected long	offset
protected String	responseType
protected String[]	supportedExtensions

Constructor Summary

Constructors

Constructor and Description
FileState()
FileState(File file)
FileState(String filename)

Method Summary

Modifier and Type	Method and Description
File	createFile()
boolean	equals(Object obj)
long	getCurrentRecord()
protected static String[]	getExtensionDescriptions(boolean input)
protected static String[]	getExtensions(boolean input)
File	getFile()
org.openscience.cdk.io.formats.IChemFormat	getFileFormat()
String	getFilename()
int	getHashCode()
long	getLastModified()
long	getLength()
long	getOffset()
String	getResponseType()
String[]	getSupportedExtDescriptions()
String[]	getSupportedExtensions()
boolean	match()
boolean	match(File file)
void	setCurrentRecord(long currentRecord)
void	setFile(File file)
void	setFile(File file, org.openscience.cdk.io.formats.IChemFormat format)
void	setFilename(String filename)
void	setHashCode(int hashCode)
void	setLastModified(long lastModified)
void	setLength(long length)
void	setOffset(long offset)
void	setResponseType(String responseType)
void	setSupportedExtDescriptions(String[] descr)
void	setSupportedExtensions(String[] ext)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MSG_FILEDONOTEXISTS

protected static transient String MSG_FILEDONOTEXISTS

MSG_CANTCREATEFILE

protected static transient String MSG_CANTCREATEFILE

MSG_OPEN

protected static transient String MSG_OPEN

MSG_UNSUPPORTEDFORMAT

protected static transient String MSG_UNSUPPORTEDFORMAT

MSG_ERRORSAVE

protected static transient String MSG_ERRORSAVE

responseType

protected String responseType

supportedExtensions

protected String[] supportedExtensions

extensionDescriptions

protected String[] extensionDescriptions

filename

protected String filename

length

protected long length

lastModified

protected long lastModified

hashCode

protected int hashCode

file

protected transient File file

offset

protected long offset

currentRecord

protected long currentRecord

fileFormat

protected org.openscience.cdk.io.formats.IChemFormat fileFormat

Constructor Detail

FileState

public FileState()

FileState

public FileState(String filename)

FileState

public FileState(File file)

Method Detail

getFileFormat

public org.openscience.cdk.io.formats.IChemFormat getFileFormat()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getFilename

public String getFilename()

Returns:

Returns the filename.

setFilename

public void setFilename(String filename)

Parameters:

filename - The filename to set.

getHashCode

public int getHashCode()

Returns:

Returns the hashCode.

setHashCode

public void setHashCode(int hashCode)

Parameters:

hashCode - The hashCode to set.

getLastModified

public long getLastModified()

Returns:

Returns the lastModified.

setLastModified

public void setLastModified(long lastModified)

Parameters:

lastModified - The lastModified to set.

getLength

public long getLength()

Returns:

Returns the length.

setLength

public void setLength(long length)

Parameters:

length - The length to set.

getFile

public File getFile()

Returns:

Returns the file.

setFile

public void setFile(File file)

setFile

public void setFile(File file,
                    org.openscience.cdk.io.formats.IChemFormat format)

Parameters:

file - The file to set.

getCurrentRecord

public long getCurrentRecord()

Specified by:

getCurrentRecord in interface IInputOutputState

Returns:

Returns the currentRecord.

setCurrentRecord

public void setCurrentRecord(long currentRecord)

Specified by:

setCurrentRecord in interface IInputOutputState

Parameters:

currentRecord - The currentRecord to set.

getOffset

public long getOffset()

Returns:

Returns the offset.

setOffset

public void setOffset(long offset)

Parameters:

offset - The offset to set.

match

public boolean match()
              throws AmbitIOException

Throws:

AmbitIOException

match

public boolean match(File file)

createFile

public File createFile()
                throws AmbitIOException

Throws:

AmbitIOException

toString

public String toString()

Overrides:

toString in class Object

getResponseType

public String getResponseType()

Specified by:

getResponseType in interface IInputOutputState

setResponseType

public void setResponseType(String responseType)

Specified by:

setResponseType in interface IInputOutputState

getSupportedExtensions

public String[] getSupportedExtensions()

getSupportedExtDescriptions

public String[] getSupportedExtDescriptions()

setSupportedExtensions

public void setSupportedExtensions(String[] ext)

setSupportedExtDescriptions

public void setSupportedExtDescriptions(String[] descr)

getExtensionDescriptions

protected static String[] getExtensionDescriptions(boolean input)

getExtensions

protected static String[] getExtensions(boolean input)