|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Project
Denotes a project, which contains the settings of the entire client, along with the last captured data.
Method Summary | |
---|---|
DataSet |
getDataSet()
Returns the current data set for this project. |
File |
getFilename()
Returns the path to the project file. |
Date |
getLastModified()
Returns the date on which the project is last saved. |
String |
getName()
Returns the name of this project. |
UserSettings |
getSettings(String aName)
Returns the other user settings, like UI-settings, and such. |
String |
getSourceVersion()
Returns the version of the OLS-client that created this project. |
boolean |
isChanged()
Returns whether the contents of this project is changed or not. |
void |
readData(Reader aReader)
Allows data to be read from a given reader, any current data in this project will be overwritten! |
void |
setCapturedData(AcquisitionResult aData)
Sets the captured data of this project. |
void |
setChanged(boolean aChanged)
Marks this project as "changed". |
void |
setFilename(File aFilename)
Sets the filename of this project. |
void |
setLastModified(Date aLastModified)
Sets the last modified date of this project. |
void |
setName(String aName)
Sets the name of this project. |
void |
setSettings(UserSettings aSettings)
Sets the user settings. |
void |
setSourceVersion(String aSourceVersion)
Sets the version of the OLS-client that saved this project. |
void |
visit(ProjectVisitor aVisitor)
Allows external callers to traverse the project structure without having to know the exact implementation details of a project. |
void |
writeData(Writer aWriter)
Allows the current data to be written to a given writer. |
Method Detail |
---|
DataSet getDataSet()
null
if there is no data yet.File getFilename()
null
in case this project is not yet saved.Date getLastModified()
null
if
this project is not yet saved.String getName()
null
if no name is yet
given.UserSettings getSettings(String aName)
aName
- the name of the user settings to retrieve, cannot be
null
.
null
.String getSourceVersion()
boolean isChanged()
true
if this project is changed, false
otherwise.void readData(Reader aReader) throws IOException
The format expected by this method is the "OLS data-file format".
aReader
- the reader to read from, cannot be null
.
IOException
- in case of I/O problems.void setCapturedData(AcquisitionResult aData)
aData
- the captured data, can be null
.void setChanged(boolean aChanged)
aChanged
- true
to mark this project as changed,
false
otherwise.void setFilename(File aFilename)
aFilename
- the filename to set, can be null
.void setLastModified(Date aLastModified)
aLastModified
- a last modified date, can be null
.void setName(String aName)
aName
- the name of this project, can be null
.void setSettings(UserSettings aSettings)
aSettings
- the user settings, cannot be null
.void setSourceVersion(String aSourceVersion)
aSourceVersion
- the source version, for example, "0.9.2", can be null
.void visit(ProjectVisitor aVisitor)
aVisitor
- the visitor callback to use, cannot be null
.void writeData(Writer aWriter) throws IOException
aWriter
- the writer to write to, cannot be null
.
IOException
- in case of I/O problems.readData(Reader)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |