de.cismet.commons.gui.protocol

Class ProtocolHandler

java.lang.Object

de.cismet.commons.gui.protocol.ProtocolHandler

All Implemented Interfaces:

de.cismet.tools.configuration.Configurable

public class ProtocolHandler
extends Object
implements de.cismet.tools.configuration.Configurable

DOCUMENT ME!

Version:

$Revision$, $Date$

Author:

jruiz

Method Summary

Modifier and Type	Method and Description
boolean	addProtocolHandlerListener(ProtocolHandlerListener listener) DOCUMENT ME!
void	clearSteps() DOCUMENT ME!
void	configure(org.jdom.Element parent)
protected void	fireRecordStateChanged(ProtocolHandlerListenerEvent event) DOCUMENT ME!
protected void	fireStepAdded(ProtocolHandlerListenerEvent event) DOCUMENT ME!
protected void	fireStepRemoved(ProtocolHandlerListenerEvent event) DOCUMENT ME!
protected void	fireStepsCleared(ProtocolHandlerListenerEvent event) DOCUMENT ME!
protected void	fireStepsRestored(ProtocolHandlerListenerEvent event) DOCUMENT ME!
void	fromJsonString(String jsonString) DOCUMENT ME!
List<ProtocolStep>	getAllSteps() DOCUMENT ME!
org.jdom.Element	getConfiguration()
static ProtocolHandler	getInstance() DOCUMENT ME!
ProtocolStep	getLastStep() DOCUMENT ME!
ProtocolStepConfiguration	getProtocolStepConfiguration(String stepKey) DOCUMENT ME!
List<ProtocolStepToolbarItem>	getToolbarItems() DOCUMENT ME!
boolean	isRecordEnabled() DOCUMENT ME!
void	masterConfigure(org.jdom.Element parent)
void	readFromFile(File file) DOCUMENT ME!
boolean	recordStep(ProtocolStep protocolStep) DOCUMENT ME!
boolean	recordStep(ProtocolStep protocolStep, boolean checkIfRecordIsEnabled) DOCUMENT ME!
boolean	removeProtocolHandlerListener(ProtocolHandlerListener listener) DOCUMENT ME!
void	removeStep(ProtocolStep protocolStep) DOCUMENT ME!
void	setRecordEnabled(boolean recordEnabled) DOCUMENT ME!
String	toJsonString() DOCUMENT ME!
void	writeToFile(File file) DOCUMENT ME!

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.cismet.tools.configuration.Configurable

configure, masterConfigure

Method Detail

getInstance

public static ProtocolHandler getInstance()

DOCUMENT ME!

Returns:

DOCUMENT ME!

addProtocolHandlerListener

public boolean addProtocolHandlerListener(ProtocolHandlerListener listener)

DOCUMENT ME!

Parameters:

listener - DOCUMENT ME!

Returns:

DOCUMENT ME!

removeProtocolHandlerListener

public boolean removeProtocolHandlerListener(ProtocolHandlerListener listener)

DOCUMENT ME!

Parameters:

listener - DOCUMENT ME!

Returns:

DOCUMENT ME!

getProtocolStepConfiguration

public ProtocolStepConfiguration getProtocolStepConfiguration(String stepKey)

DOCUMENT ME!

Parameters:

stepKey - DOCUMENT ME!

Returns:

DOCUMENT ME!

setRecordEnabled

public void setRecordEnabled(boolean recordEnabled)

DOCUMENT ME!

Parameters:

recordEnabled - DOCUMENT ME!

isRecordEnabled

public boolean isRecordEnabled()

DOCUMENT ME!

Returns:

DOCUMENT ME!

removeStep

public void removeStep(ProtocolStep protocolStep)

DOCUMENT ME!

Parameters:

protocolStep - DOCUMENT ME!

recordStep

public boolean recordStep(ProtocolStep protocolStep)

DOCUMENT ME!

Parameters:

protocolStep - DOCUMENT ME!

Returns:

DOCUMENT ME!

recordStep

public boolean recordStep(ProtocolStep protocolStep,
                          boolean checkIfRecordIsEnabled)

DOCUMENT ME!

Parameters:

protocolStep - DOCUMENT ME!

checkIfRecordIsEnabled - DOCUMENT ME!

Returns:

DOCUMENT ME!

getLastStep

public ProtocolStep getLastStep()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getAllSteps

public List<ProtocolStep> getAllSteps()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getToolbarItems

public List<ProtocolStepToolbarItem> getToolbarItems()

DOCUMENT ME!

Returns:

DOCUMENT ME!

clearSteps

public void clearSteps()

DOCUMENT ME!

toJsonString

public String toJsonString()
                    throws com.fasterxml.jackson.core.JsonProcessingException

DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

com.fasterxml.jackson.core.JsonProcessingException - DOCUMENT ME!

fromJsonString

public void fromJsonString(String jsonString)
                    throws IOException,
                           ClassNotFoundException

DOCUMENT ME!

Parameters:

jsonString - DOCUMENT ME!

Throws:

IOException - DOCUMENT ME!

ClassNotFoundException - DOCUMENT ME!

readFromFile

public void readFromFile(File file)
                  throws IOException,
                         ClassNotFoundException

DOCUMENT ME!

Parameters:

file - DOCUMENT ME!

Throws:

IOException - DOCUMENT ME!

ClassNotFoundException - DOCUMENT ME!

writeToFile

public void writeToFile(File file)
                 throws IOException

DOCUMENT ME!

Parameters:

file - DOCUMENT ME!

Throws:

IOException - DOCUMENT ME!

fireRecordStateChanged

protected void fireRecordStateChanged(ProtocolHandlerListenerEvent event)

DOCUMENT ME!

Parameters:

event - DOCUMENT ME!

fireStepAdded

protected void fireStepAdded(ProtocolHandlerListenerEvent event)

DOCUMENT ME!

Parameters:

event - DOCUMENT ME!

fireStepRemoved

protected void fireStepRemoved(ProtocolHandlerListenerEvent event)

DOCUMENT ME!

Parameters:

event - DOCUMENT ME!

fireStepsCleared

protected void fireStepsCleared(ProtocolHandlerListenerEvent event)

DOCUMENT ME!

Parameters:

event - DOCUMENT ME!

fireStepsRestored

protected void fireStepsRestored(ProtocolHandlerListenerEvent event)

DOCUMENT ME!

Parameters:

event - DOCUMENT ME!

configure

public void configure(org.jdom.Element parent)

Specified by:

configure in interface de.cismet.tools.configuration.Configurable

masterConfigure

public void masterConfigure(org.jdom.Element parent)

Specified by:

masterConfigure in interface de.cismet.tools.configuration.Configurable

getConfiguration

public org.jdom.Element getConfiguration()
                                  throws de.cismet.tools.configuration.NoWriteError

Specified by:

getConfiguration in interface de.cismet.tools.configuration.Configurable

Throws:

de.cismet.tools.configuration.NoWriteError