org.wandora.application.tools.exporters.iiifexport

Class IIIFExport

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.exporters.AbstractExportTool

org.wandora.application.tools.exporters.iiifexport.IIIFExport

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, WandoraTool, WandoraToolLogger, TopicMapLogger

public class IIIFExport
extends AbstractExportTool

Author:

olli

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashMap<java.lang.String,java.lang.String>	options
protected boolean	prettyPrint
protected IIIFBuilder	selectedBuilder

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
IIIFExport()

Method Summary

Modifier and Type	Method and Description
void	configure(Wandora wandora, Options options, java.lang.String prefix) If the tool is configurable, shows an user interface to configure the tool.
void	execute(Wandora wandora, Context context) Runs the tool.
java.util.ArrayList<IIIFBuilder>	getBuilders()
java.lang.String	getDescription() AdminToolManager views tool descriptions while user browses available tools and build user customizable GUI elements such as Tools menu.
java.lang.String	getName() Tools name represent the tool in UI unless the tool has been given explicitly another GUI name.
WandoraToolType	getType() Tool type is used to categorize tools.
void	initialize(Wandora wandora, Options options, java.lang.String prefix) Initializes a tool with options saved in the options.
boolean	isConfigurable() Whether this tool is configurable.
IIIFBuilder	resolveBuilder(java.lang.String name)
void	setBuilder(IIIFBuilder builder)
void	setPrettyPrint(boolean p)
void	writeOptions(Wandora wandora, Options options, java.lang.String prefix) If the tool is configurable, saves all current tool options.

Methods inherited from class org.wandora.application.tools.exporters.AbstractExportTool

getIcon, makeTopicMapWith, makeTopicMapWith

Methods inherited from class org.wandora.application.tools.AbstractWandoraTool

addUndoMarker, addUndoMarker, allowMultipleInvocations, clearAllThreads, clearThreads, clearThreads, clearToolLock, clearToolLock, clearToolLocks, execute, execute, forceStop, forceStop, getContext, getCurrentLogger, getDefaultLogger, getHistory, getLastLogger, getState, getThreads, getThreads, getToolMenuItem, getToolMenuItem, getTopicName, hlog, interruptAllThreads, interruptThreads, interruptThreads, isRunning, isRunning, lockLog, log, log, log, log, requiresRefresh, run, runInOwnThread, setContext, setDefaultLogger, setLogTitle, setProgress, setProgressMax, setState, setToolLogger, singleLog, singleLog, singleLog, solveContextTopicMap, solveNameForTopicMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.wandora.application.WandoraTool

execute, execute, getContext, getToolMenuItem, hlog, isRunning, log, log, log, log, requiresRefresh, setContext, setToolLogger

Methods inherited from interface org.wandora.application.WandoraToolLogger

forceStop, getHistory, getState, lockLog, setLogTitle, setProgress, setProgressMax, setState

Field Detail

options

protected java.util.HashMap<java.lang.String,java.lang.String> options

selectedBuilder

protected IIIFBuilder selectedBuilder

prettyPrint

protected boolean prettyPrint

Constructor Detail

IIIFExport

public IIIFExport()

Method Detail

getType

public WandoraToolType getType()

Description copied from class: AbstractWandoraTool

Tool type is used to categorize tools. Tool type has no real effect today, it is merely an informative property of a tool.

Specified by:

getType in interface WandoraTool

Overrides:

getType in class AbstractExportTool

Returns:

Tool's type object.

getDescription

public java.lang.String getDescription()

Description copied from class: AbstractWandoraTool

AdminToolManager views tool descriptions while user browses available tools and build user customizable GUI elements such as Tools menu. By default description equals the tool name. All tools should override this method.

Specified by:

getDescription in interface WandoraTool

Overrides:

getDescription in class AbstractWandoraTool

Returns:

String representing tool's description.

getName

public java.lang.String getName()

Description copied from class: AbstractWandoraTool

Tools name represent the tool in UI unless the tool has been given explicitly another GUI name. All tools should override this method and return a valid string representing name of the tool.

Specified by:

getName in interface WandoraTool

Overrides:

getName in class AbstractWandoraTool

Returns:

String representing tool's name.

getBuilders

public java.util.ArrayList<IIIFBuilder> getBuilders()

resolveBuilder

public IIIFBuilder resolveBuilder(java.lang.String name)

initialize

public void initialize(Wandora wandora,
                       Options options,
                       java.lang.String prefix)
                throws TopicMapException

Description copied from class: AbstractWandoraTool

Initializes a tool with options saved in the options. Options for this tool start with the given prefix. What options the tool saves is entirely tool specific.

Specified by:

initialize in interface WandoraTool

Overrides:

initialize in class AbstractWandoraTool

Throws:

TopicMapException

writeOptions

public void writeOptions(Wandora wandora,
                         Options options,
                         java.lang.String prefix)

Description copied from class: AbstractWandoraTool

If the tool is configurable, saves all current tool options. Options specific to this tool should be saved with keys starting with the given prefix.

Specified by:

writeOptions in interface WandoraTool

Overrides:

writeOptions in class AbstractWandoraTool

configure

public void configure(Wandora wandora,
                      Options options,
                      java.lang.String prefix)
               throws TopicMapException

Description copied from class: AbstractWandoraTool

If the tool is configurable, shows an user interface to configure the tool. The user may edit tool options which this method also need to save. Options specific to this tool should be saved with keys starting with the given prefix.

Specified by:

configure in interface WandoraTool

Overrides:

configure in class AbstractWandoraTool

Throws:

TopicMapException

setBuilder

public void setBuilder(IIIFBuilder builder)

setPrettyPrint

public void setPrettyPrint(boolean p)

isConfigurable

public boolean isConfigurable()

Description copied from class: AbstractWandoraTool

Whether this tool is configurable. Configurable tools will provide an interface to configure themselves. To make a configurable tool you will need to:

• Implement isConfigurable method and return true there.
• Implement initialize method to initialize the tool with saved options.
• Implement configure method to provide the user interface for configuration and then save the new options.
• Implement writeOptions method to save the current options.

Specified by:

isConfigurable in interface WandoraTool

Overrides:

isConfigurable in class AbstractWandoraTool

Returns:

true if the tool is configurable.

execute

public void execute(Wandora wandora,
                    Context context)
             throws TopicMapException

Description copied from interface: WandoraTool

Runs the tool. This is the main entry to the tool. Here the context

Throws:

TopicMapException