de.tuberlin.cs.flp.jspwiki.plugin.wikiarchive


Class ArchiveHandlerExternalFormatAbstract

de.tuberlin.cs.flp.jspwiki.plugin.wikiarchive.ArchiveHandlerAbstract
    inheritde.tuberlin.cs.flp.jspwiki.plugin.wikiarchive.ArchiveHandlerExternalFormatAbstract
All known Subclassifier:
ArchiveHandlerBibTeX , ArchiveHandlerPlaintext , ArchiveHandlerXML


public abstract class ArchiveHandlerExternalFormatAbstract
Namespace: wikiarchive


Common superclass for archive handlers that interface to an external data format.
Authors:
Jens Gulden


Method Summary
public Object   createData()
Creates an empty data source to be filled for export.  
public String   dataToString(Object data)
Converts data source to string for export.  
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.  
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

Method Detail

createData

public Object createData()


Creates an empty data source to be filled for export.
Returns:


dataToString

public String dataToString(Object data)


Converts data source to string for export.
Parameters:
data -
Returns:


msgDone

protected String msgDone(ArchiveEntry entry, ArchiveEntry outEntry, int mode)


Outputs a message informing about the action that has been taken for an entry.
Parameters:
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().
Returns:
The message string. (Actually used to build a part of an HTML-form user interface.)


msgNotDone

protected String msgNotDone(ArchiveEntry entry, ArchiveEntry outEntry, int mode)


Outputs a message informing that an action has not been taken for an entry.
Parameters:
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().
Returns:
The message string. (Actually used to build a part of an HTML-form user interface.)


msgToDo

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.
Parameters:
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().
Returns:
The message string. (Actually used to build a part of an HTML-form user interface.)


stringToData

public void stringToData(String s, Object data)


Converts a string to a handled data source for import.
Parameters:
s -
data -

previous   TOC   next

Generated with Poseidon for UMLTM.
Poseidon is a registered trademark of Gentleware AG in the USA and other countries. Copyright 2003-2006 Gentleware AG, Ludwigstr. 12, 20357 Hamburg, Germany. All Rights Reserved.
UML is a trademark or registered trademark of Object Management Group, Inc. in the U.S. and other countries.