insensa.inforeader
Interface InfoReader

All Superinterfaces:
java.lang.Runnable
All Known Implementing Classes:
AbstractInfoReader, CCountIntervalValues, CCountValues, CCountValuesBlocksize, CEqualBreaksValues, CGetPointInformation, CJenksOptimalBreaksValues, CKMeansValues, CMeanValue, CMedianValue, CMinMaxValues, CPrecisionValues, CPrioritizationValues, CQuantileBreaksValues, CQuartileValues, CStandardDeviationValue, CVariableBreaksValues, CZeroRangeValues

public interface InfoReader
extends java.lang.Runnable


Method Summary
 java.util.List<java.lang.String> getDependencies()
          Returns a list with names of InfoReaders that have to be executed before this InfoReader can be executed.
 java.lang.String getErrorMassage()
           
 org.jdom.Element getInfoElement()
           
 java.lang.String getInfoName()
           
 java.util.Vector<java.util.Vector<java.lang.String>> getInfos()
           
 CRasterFileInformation getTargetFile()
          Returns the file of type CRasterFileInformation that holds this InfoReader targetFile will only be set if the InfoReader operation was performed, otherwise null
 java.util.List<VariableValue<java.lang.String>> getVariableList()
           
 boolean isRead()
           
 void readInfos(CRasterFileInformation file)
          This method will try to receive all informations from dependent InfoReader You can get InfoReader with file.getInfoReader(nameOfInfoReader);
 void setDependencyChecker(DependencyChecker mDep)
          Set dependency checker
 void setInfos(org.jdom.Element eInfo)
          Restore saved data
 void setTargetFile(CRasterFileInformation targetFile)
          determines the target file for this InfoReader.
 void setUnread()
          Set InfoReader to unread to execute it again
 void setVariableList(java.util.List<VariableValue<java.lang.String>> varList)
          Configure InfoReader
 void setWorkerStatus(WorkerStatus mWorkerStatus)
          Determines a WorkerStatus to listen to execution progress
 
Methods inherited from interface java.lang.Runnable
run
 

Method Detail

getDependencies

java.util.List<java.lang.String> getDependencies()
Returns a list with names of InfoReaders that have to be executed before this InfoReader can be executed.

Returns:
a list with names of InfoReaders

getErrorMassage

java.lang.String getErrorMassage()
Returns:
The error message if an error occurs

getInfoElement

org.jdom.Element getInfoElement()
                                throws java.io.IOException
Returns:
Throws:
java.io.IOException

getInfoName

java.lang.String getInfoName()
Returns:
The name of this InfoReader

getInfos

java.util.Vector<java.util.Vector<java.lang.String>> getInfos()
Returns:
Information to Display in Data Table

getTargetFile

CRasterFileInformation getTargetFile()
Returns the file of type CRasterFileInformation that holds this InfoReader targetFile will only be set if the InfoReader operation was performed, otherwise null

Returns:
the file that holds this InfoReader

getVariableList

java.util.List<VariableValue<java.lang.String>> getVariableList()
Returns:
the variables that can be set or null if there is none

isRead

boolean isRead()
Returns:
true is already executed

readInfos

void readInfos(CRasterFileInformation file)
               throws java.io.FileNotFoundException,
                      java.io.IOException
This method will try to receive all informations from dependent InfoReader You can get InfoReader with file.getInfoReader(nameOfInfoReader);

Parameters:
file - File that holds this InfoReader
Throws:
java.io.FileNotFoundException
java.io.IOException

setDependencyChecker

void setDependencyChecker(DependencyChecker mDep)
Set dependency checker

Parameters:
mDep -
See Also:
AbstractInfoReader.setDependencyChecker(insensa.helpers.DependencyChecker)

setInfos

void setInfos(org.jdom.Element eInfo)
              throws java.io.IOException
Restore saved data

Parameters:
eInfo -
Throws:
java.io.IOException

setTargetFile

void setTargetFile(CRasterFileInformation targetFile)
determines the target file for this InfoReader.

Parameters:
targetFile - Target file of type CRasterFileInformation for this InfoReader

setUnread

void setUnread()
Set InfoReader to unread to execute it again


setVariableList

void setVariableList(java.util.List<VariableValue<java.lang.String>> varList)
Configure InfoReader

Parameters:
varList - the List of Variables to be set

setWorkerStatus

void setWorkerStatus(WorkerStatus mWorkerStatus)
Determines a WorkerStatus to listen to execution progress

Parameters:
mWorkerStatus -