Package adams.flow.processor

Class ListDatabaseConnections

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.processor.AbstractActorProcessor

adams.flow.processor.AbstractListingProcessor

adams.flow.processor.ListDatabaseConnections

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<ActorProcessor>, SizeOfHandler, ActorProcessor, GraphicalOutputProducingProcessor, ListingProcessor, Serializable, Comparable<ActorProcessor>

public class ListDatabaseConnections
extends AbstractListingProcessor

Processor that lists database connections.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.flow.processor.AbstractListingProcessor

m_List

Fields inherited from class adams.flow.processor.AbstractActorProcessor

m_Errors

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
ListDatabaseConnections()

Method Summary

Modifier and Type	Method	Description
protected String	getHeader()	Returns the header to use in the dialog, i.e., the one-liner that explains the output.
String	getTitle()	Returns the title for the dialog.
String	globalInfo()	Returns a string describing the object.
protected boolean	isSortedList()	Returns whether the list should be sorted.
protected boolean	isUniqueList()	Returns whether the list should not contain any duplicates.
protected boolean	isValid(AbstractOption option, Object obj, OptionTraversalPath path)	Checks whether the object is valid and should be added to the list.
protected String	objectToString(AbstractOption option, Object obj, OptionTraversalPath path)	Returns the string representation of the object that is added to the list.

Methods inherited from class adams.flow.processor.AbstractListingProcessor

finalizeList, generatesMultipleItems, getDefaultSize, getGraphicalOutput, getList, hasGraphicalOutput, initializeList, objectToStrings, process, processActor

Methods inherited from class adams.flow.processor.AbstractActorProcessor

addError, addError, checkData, compareTo, equals, getErrors, hasErrors, initialize, process, reset, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.flow.processor.ActorProcessor

compareTo, getErrors, hasErrors, process, shallowCopy, shallowCopy

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Constructor Detail

ListDatabaseConnections

public ListDatabaseConnections()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

getTitle

public String getTitle()

Returns the title for the dialog.

Returns:

the title

isValid

protected boolean isValid(AbstractOption option,
                          Object obj,
                          OptionTraversalPath path)

Checks whether the object is valid and should be added to the list.

Specified by:

isValid in class AbstractListingProcessor

Parameters:

option - the current option

obj - the object to check

path - the traversal path of properties

Returns:

true if valid

objectToString

protected String objectToString(AbstractOption option,
                                Object obj,
                                OptionTraversalPath path)

Returns the string representation of the object that is added to the list.

Overrides:

objectToString in class AbstractListingProcessor

Parameters:

option - the current option

obj - the object to turn into a string

path - the traversal path of properties

Returns:

the string representation, null if to ignore the item

isSortedList

protected boolean isSortedList()

Returns whether the list should be sorted.

Specified by:

isSortedList in class AbstractListingProcessor

Returns:

true if the list should get sorted

isUniqueList

protected boolean isUniqueList()

Returns whether the list should not contain any duplicates.

Specified by:

isUniqueList in class AbstractListingProcessor

Returns:

true if the list contains no duplicates

getHeader

protected String getHeader()

Returns the header to use in the dialog, i.e., the one-liner that explains the output.

Specified by:

getHeader in class AbstractListingProcessor

Returns:

the header, null if no header available