de.tuberlin.cs.flp.jspwiki.plugin.wikiarchive
ArchiveIOHandler
easier.
|
|||
protected
Map
|
config |
|
|||
public
Object
|
createData()
Creates an empty data source to be filled for export.
|
||
protected
void
|
createEntry(Object data, ArchiveEntry entry)
Creates a new archive entry in the data source handled by this ArchiveIOHandler.
@param plugin The WikiArcive plugin.
|
||
public
String
|
dataToString(Object data)
Converts the handled data source to string for export.
|
||
protected
boolean
|
equalEntries(ArchiveEntry a, ArchiveEntry b)
Tests whether all data carried by two entries is the same.
Note that this is different from using Comparators on ArchiveEntry
objects, because Comparators only look at entry-names, while this method
compares all entry-data.
|
||
public
String
|
getContentSuffix()
Content type for export via HTTP.
|
||
public
String
|
getContentType()
Content type for export via HTTP.
|
||
public
void
|
init(WikiEngine engine, Map config)
Initialize this ArchiveHandler.
|
||
protected
String
|
msgDone(ArchiveEntry entry, ArchiveEntry outEntry, int mode)
Outputs a message informing about the action that has been taken for an entry.
|
||
protected
String
|
msgNotDone(ArchiveEntry entry, ArchiveEntry outEntry, int mode)
Outputs a message informing that an action has not been taken for an entry.
|
||
protected
String
|
msgToDo(ArchiveEntry inEntry, ArchiveEntry outEntry, int mode)
Outputs a message informing about the possible action to be taken for an input entry, e.g.
whether it would be added as a new entry, or an existing one would be updated.
|
||
protected
Map
|
parseAll(Object data)
Retrieves all archive entries from the data source.
|
||
public
String
|
performIO(boolean io, Archive archive, Object data, int mode, Collection exceptions)
Perform either input from the
Archive model interface
into the data source handled by this ArchiveIOHandler.
@param plugin The WikiArchive plugin. |
||
protected
void
|
replaceEntry(Object data, ArchiveEntry newEntry, ArchiveEntry oldEntry)
Replaces an archive entry in the data source handled by this ArchiveIOHandler.
@param plugin The WikiArcive plugin.
|
||
public
void
|
stringToData(String s, Object data)
Converts a string to a handled data source for import.
|
|
|||
|
|||
|
|||
Tagged Values | |
static
|
false
|
documentation#author
|
Jens Gulden
|
documentation#version
|
0.2.0
|
|
protected
Map config
|
public
Object
createData()
protected
void createEntry(Object data, ArchiveEntry entry)
Method Tagged Values | |
documentation#throws
|
IOException if an i/o error occurs
|
data
- The data source handled by this ArchiveIOHandler.
entry
- The entry.
public
String
dataToString(Object data)
data
-
protected
boolean equalEntries(ArchiveEntry a, ArchiveEntry b)
a
- One archive entry.
b
- Another archive entry.
public
String
getContentSuffix()
public
String
getContentType()
public
void init(WikiEngine engine, Map config)
engine
-
config
-
protected
String
msgDone(ArchiveEntry entry, ArchiveEntry outEntry, int mode)
entry
- The entry processed.
outEntry
- The currently existing possible output entry, or null if such does not exist yet.
mode
- The action mode, like the mode
parameter of performIO().
protected
String
msgNotDone(ArchiveEntry entry, ArchiveEntry outEntry, int mode)
entry
- The entry not processed.
outEntry
- The currently existing possible output entry, or null if such does not exist yet.
mode
- The action mode, like the mode
parameter of performIO().
protected
String
msgToDo(ArchiveEntry inEntry, ArchiveEntry outEntry, int mode)
inEntry
- The input entry.
outEntry
- The currently existing possible output entry, or null if such does not exist yet.
mode
- The action mode, like the mode
parameter of performIO().
protected
Map
parseAll(Object data)
Method Tagged Values | |
documentation#throws
|
IOException if an i/o error occurs
|
data
- The data source handled by this ArchiveIOHandler.
public
String
performIO(boolean io, Archive archive, Object data, int mode, Collection exceptions)
Archive
model interface
into the data source handled by this ArchiveIOHandler.
@param plugin The WikiArchive plugin.Method Tagged Values | |
documentation#throws
|
IOException if an i/o error occurs
|
io
- Switch between input or output mode, Archive
model interface.
archive
- The Archive
model interface.
data
- The data source handled by this ArchiveIOHandler.
mode
- The processing mode. This is a bit mask with:exceptions
- Collection of entry names that should be treated as exceptions to the behaviour specified by mode
. (Not used.)
protected
void replaceEntry(Object data, ArchiveEntry newEntry, ArchiveEntry oldEntry)
Method Tagged Values | |
documentation#throws
|
IOException if an i/o error occurs
|
data
- The data source handled by this ArchiveIOHandler.
newEntry
- The new entry.
oldEntry
- The old entry.
public
void stringToData(String s, Object data)
s
-
data
-
|
public
ArchiveHandlerAbstract ArchiveHandlerAbstract
[1..1]
protected
WikiEngine engine
[1..1] navigable
Association Tagged Values | |
gentleware-initialValue
|
|