Package adams.gui.visualization.object.objectannotations.check

Class RequireMetaData

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.object.objectannotations.check.AbstractAnnotationCheck

adams.gui.visualization.object.objectannotations.check.RequireMetaData

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, AnnotationCheck, Serializable

public class RequireMetaData
extends AbstractAnnotationCheck

Requires the specified meta-data key to be present in all objects.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_Key	the meta-data key to be present.

Fields inherited from class adams.gui.visualization.object.objectannotations.check.AbstractAnnotationCheck

m_Enabled

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
RequireMetaData()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected String	doCheckAnnotations(LocatedObjects objects)	Checks the annotations.
protected int[]	doFindInvalidAnnotationsIndices(LocatedObjects objects)	Checks the annotations and returns the indices of the invalid ones.
String	getKey()	Returns the meta-data key that must be present.
String	globalInfo()	Returns a string describing the object.
String	keyTipText()	Returns the tip text for this property.
void	setKey(String value)	Sets the meta-data key that must be present.

Methods inherited from class adams.gui.visualization.object.objectannotations.check.AbstractAnnotationCheck

check, checkAnnotations, enabledTipText, findInvalidAnnotationsIndices, generateQuickInfo, getEnabled, getQuickInfo, setEnabled

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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, getOptionManager, toCommandLine

Field Detail

m_Key

protected String m_Key

the meta-data key to be present.

Constructor Detail

RequireMetaData

public RequireMetaData()

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

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractAnnotationCheck

setKey

public void setKey(String value)

Sets the meta-data key that must be present.

Parameters:

value - the key

getKey

public String getKey()

Returns the meta-data key that must be present.

Returns:

the key

keyTipText

public String keyTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

doCheckAnnotations

protected String doCheckAnnotations(LocatedObjects objects)

Checks the annotations.

Specified by:

doCheckAnnotations in class AbstractAnnotationCheck

Parameters:

objects - the annotations to check

Returns:

null if checks passed, otherwise error message

doFindInvalidAnnotationsIndices

protected int[] doFindInvalidAnnotationsIndices(LocatedObjects objects)

Checks the annotations and returns the indices of the invalid ones.

Specified by:

doFindInvalidAnnotationsIndices in class AbstractAnnotationCheck

Parameters:

objects - the annotations to check

Returns:

the invalid indices, 0-length array if no invalid ones