|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectstory.scheherazade.virgil.VirgilFile
public class VirgilFile
Handles Virgil file I/O. Class represents a virgil memento, including Scheherazade StoryTelling and Virgil metadata on the higher level. Use it to load a Virgil story by using the file constructor and then the data access methods. Use it to save a file with the data constructor and save() method.
Field Summary | |
---|---|
static java.lang.String |
CONFIG_KEY
|
static java.lang.String |
FILE_FORMAT_CONFIG_KEY
|
static java.lang.String |
SCH_SAVED_STORY
|
static java.lang.String |
SOURCE_STORY
|
static java.lang.String |
SOURCE_STORY_BELOW
|
static java.lang.String |
SOURCE_STORY_ID
|
static java.lang.String |
STORY_POINT
|
static java.lang.String |
STORY_POINTS
|
static java.lang.String |
TIMELINE_ID
|
static java.lang.String |
UID_ATT
|
static java.lang.String |
VISIBLE_STATES
|
static java.lang.String |
VISIBLE_STATES_SET
|
Constructor Summary | |
---|---|
VirgilFile(java.io.File fileToOpen)
Constructor for parsing (opening) from disk. |
|
VirgilFile(StoryTelling telling,
int tellingFloor,
VisibleStates visibleStates,
int configKey,
java.lang.String UID,
java.lang.String sourceStoryID,
java.lang.String sourceStory)
Constructor for populating with live data. |
Method Summary | |
---|---|
boolean |
errorDuringParse()
The data is NOT ready if we encountered a parse error during construction. |
int |
getConfigKey()
|
java.io.File |
getFilename()
|
Scheherexception |
getParseError()
|
java.lang.String |
getSourceStory()
|
java.lang.String |
getSourceStoryID()
|
StoryTelling |
getStoryTelling()
|
java.lang.String |
getUID()
|
VisibleStates |
getVisibleStates()
|
java.lang.StringBuffer |
render()
|
void |
save(java.io.File fileToSave)
Save the current Virgil memento to disk. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String FILE_FORMAT_CONFIG_KEY
public static final java.lang.String SCH_SAVED_STORY
public static final java.lang.String SOURCE_STORY
public static final java.lang.String VISIBLE_STATES_SET
public static final java.lang.String VISIBLE_STATES
public static final java.lang.String STORY_POINTS
public static final java.lang.String STORY_POINT
public static final java.lang.String SOURCE_STORY_BELOW
public static final java.lang.String CONFIG_KEY
public static final java.lang.String UID_ATT
public static final java.lang.String SOURCE_STORY_ID
public static final java.lang.String TIMELINE_ID
Constructor Detail |
---|
public VirgilFile(StoryTelling telling, int tellingFloor, VisibleStates visibleStates, int configKey, java.lang.String UID, java.lang.String sourceStoryID, java.lang.String sourceStory) throws Scheherexception
Scheherexception
public VirgilFile(java.io.File fileToOpen)
Method Detail |
---|
public void save(java.io.File fileToSave) throws Scheherexception
Scheherexception
public boolean errorDuringParse()
public Scheherexception getParseError()
public java.io.File getFilename()
public VisibleStates getVisibleStates() throws Scheherexception
Scheherexception
public int getConfigKey()
public StoryTelling getStoryTelling() throws Scheherexception
Scheherexception
public java.lang.String getUID()
public java.lang.String getSourceStoryID()
public java.lang.StringBuffer render()
render
in interface RenderableObject
public java.lang.String getSourceStory()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |