java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.flow.transformer.draw.AbstractDrawOperation
      - adams.flow.transformer.draw.AbstractDrawObjectsFromReport

All Implemented Interfaces:

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

Direct Known Subclasses:

ObjectCentersFromReport, ObjectLocationsFromReport
```
public abstract class AbstractDrawObjectsFromReport
extends AbstractDrawOperation
```
Ancestor for overlays that use object locations from a report.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected ReportObjectOverlay m_Overlays
the overlay handler.
- Fields inherited from class adams.flow.transformer.draw.AbstractDrawOperation
  m_Owner
- 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

AbstractDrawObjectsFromReport()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`colorTipText()`	Returns the tip text for this property.
`void`	`defineOptions()`	Adds options to the internal list of options.
`protected String`	`doDraw(BufferedImageContainer image)`	Performs the actual draw operation.
`protected abstract String`	`doDraw(BufferedImageContainer image, List<Polygon> locations)`	Performs the actual drawing of the objects.
`Color`	`getColor()`	Returns the color to use for the objects.
`ImageAnchor`	`getLabelAnchor()`	Returns the anchor for the label.
`Font`	`getLabelFont()`	Returns the label font.
`String`	`getLabelFormat()`	Returns the label format.
`int`	`getLabelOffsetX()`	Returns the X offset for the label.
`int`	`getLabelOffsetY()`	Returns the Y offset for the label.
`BaseString[]`	`getPredefinedLabels()`	Returns the predefined labels.
`String`	`getPrefix()`	Returns the prefix to use for the objects in the report.
`ColorProvider`	`getTypeColorProvider()`	Returns the color provider to use for the types.
`BaseRegExp`	`getTypeRegExp()`	Returns the regular expression that the types must match in order to get drawn.
`String`	`getTypeSuffix()`	Returns the suffix to use for the types.
`boolean`	`getUseColorsPerType()`	Returns whether to use colors per type.
`protected void`	`initialize()`	Initializes the members.
`String`	`labelAnchorTipText()`	Returns the tip text for this property.
`String`	`labelFontTipText()`	Returns the tip text for this property.
`String`	`labelFormatTipText()`	Returns the tip text for this property.
`String`	`labelOffsetXTipText()`	Returns the tip text for this property.
`String`	`labelOffsetYTipText()`	Returns the tip text for this property.
`String`	`predefinedLabelsTipText()`	Returns the tip text for this property.
`String`	`prefixTipText()`	Returns the tip text for this property.
`void`	`setColor(Color value)`	Sets the color to use for the objects.
`void`	`setLabelAnchor(ImageAnchor value)`	Sets the anchor for the label.
`void`	`setLabelFont(Font value)`	Sets the label font.
`void`	`setLabelFormat(String value)`	Sets the label format.
`void`	`setLabelOffsetX(int value)`	Sets the X offset for the label.
`void`	`setLabelOffsetY(int value)`	Sets the Y offset for the label.
`void`	`setPredefinedLabels(BaseString[] value)`	Sets the predefined labels.
`void`	`setPrefix(String value)`	Sets the prefix to use for the objects in the report.
`void`	`setTypeColorProvider(ColorProvider value)`	Sets the color provider to use for the types.
`void`	`setTypeRegExp(BaseRegExp value)`	Sets the regular expression that the types must match in order to get drawn.
`void`	`setTypeSuffix(String value)`	Sets the suffix to use for the types.
`void`	`setUseColorsPerType(boolean value)`	Sets whether to use colors per type.
`String`	`typeColorProviderTipText()`	Returns the tip text for this property.
`String`	`typeRegExpTipText()`	Returns the tip text for this property.
`String`	`typeSuffixTipText()`	Returns the tip text for this property.
`String`	`useColorsPerTypeTipText()`	Returns the tip text for this property.

Methods inherited from class adams.flow.transformer.draw.AbstractDrawOperation
check, draw, getOwner, getQuickInfo, setOwner

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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.logging.LoggingLevelHandler
getLoggingLevel

- Field Detail
  - m_Overlays
```
protected ReportObjectOverlay m_Overlays
```
    the overlay handler.
- Constructor Detail
  - AbstractDrawObjectsFromReport
```
public AbstractDrawObjectsFromReport()
```
- Method Detail
  - defineOptions
```
public void defineOptions()
```
    Adds options to the internal list of options.
    
    Specified by:
    
    defineOptions in interface OptionHandler
    
    Overrides:
    
    defineOptions in class AbstractOptionHandler
  - initialize
```
protected void initialize()
```
    Initializes the members.
    
    Overrides:
    
    initialize in class AbstractOptionHandler
  - setPrefix
```
public void setPrefix(String value)
```
    Sets the prefix to use for the objects in the report.
    
    Parameters:
    
    value - the prefix
  - getPrefix
```
public String getPrefix()
```
    Returns the prefix to use for the objects in the report.
    
    Returns:
    
    the prefix
  - prefixTipText
```
public String prefixTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setColor
```
public void setColor(Color value)
```
    Sets the color to use for the objects.
    
    Parameters:
    
    value - the color
  - getColor
```
public Color getColor()
```
    Returns the color to use for the objects.
    
    Returns:
    
    the color
  - colorTipText
```
public String colorTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setUseColorsPerType
```
public void setUseColorsPerType(boolean value)
```
    Sets whether to use colors per type.
    
    Parameters:
    
    value - true if to use colors per type
  - getUseColorsPerType
```
public boolean getUseColorsPerType()
```
    Returns whether to use colors per type.
    
    Returns:
    
    true if to use colors per type
  - useColorsPerTypeTipText
```
public String useColorsPerTypeTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setTypeColorProvider
```
public void setTypeColorProvider(ColorProvider value)
```
    Sets the color provider to use for the types.
    
    Parameters:
    
    value - the provider
  - getTypeColorProvider
```
public ColorProvider getTypeColorProvider()
```
    Returns the color provider to use for the types.
    
    Returns:
    
    the provider
  - typeColorProviderTipText
```
public String typeColorProviderTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setTypeSuffix
```
public void setTypeSuffix(String value)
```
    Sets the suffix to use for the types.
    
    Parameters:
    
    value - the suffix
  - getTypeSuffix
```
public String getTypeSuffix()
```
    Returns the suffix to use for the types.
    
    Returns:
    
    the suffix
  - typeSuffixTipText
```
public String typeSuffixTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setTypeRegExp
```
public void setTypeRegExp(BaseRegExp value)
```
    Sets the regular expression that the types must match in order to get drawn.
    
    Parameters:
    
    value - the expression
  - getTypeRegExp
```
public BaseRegExp getTypeRegExp()
```
    Returns the regular expression that the types must match in order to get drawn.
    
    Returns:
    
    the expression
  - typeRegExpTipText
```
public String typeRegExpTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setLabelFormat
```
public void setLabelFormat(String value)
```
    Sets the label format.
    
    Parameters:
    
    value - the label format
  - getLabelFormat
```
public String getLabelFormat()
```
    Returns the label format.
    
    Returns:
    
    the label format
  - labelFormatTipText
```
public String labelFormatTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setLabelFont
```
public void setLabelFont(Font value)
```
    Sets the label font.
    
    Parameters:
    
    value - the label font
  - getLabelFont
```
public Font getLabelFont()
```
    Returns the label font.
    
    Returns:
    
    the label font
  - labelFontTipText
```
public String labelFontTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setLabelAnchor
```
public void setLabelAnchor(ImageAnchor value)
```
    Sets the anchor for the label.
    
    Parameters:
    
    value - the anchor
  - getLabelAnchor
```
public ImageAnchor getLabelAnchor()
```
    Returns the anchor for the label.
    
    Returns:
    
    the anchor
  - labelAnchorTipText
```
public String labelAnchorTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setLabelOffsetX
```
public void setLabelOffsetX(int value)
```
    Sets the X offset for the label.
    
    Parameters:
    
    value - the X offset
  - getLabelOffsetX
```
public int getLabelOffsetX()
```
    Returns the X offset for the label.
    
    Returns:
    
    the X offset
  - labelOffsetXTipText
```
public String labelOffsetXTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setLabelOffsetY
```
public void setLabelOffsetY(int value)
```
    Sets the Y offset for the label.
    
    Parameters:
    
    value - the Y offset
  - getLabelOffsetY
```
public int getLabelOffsetY()
```
    Returns the Y offset for the label.
    
    Returns:
    
    the Y offset
  - labelOffsetYTipText
```
public String labelOffsetYTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setPredefinedLabels
```
public void setPredefinedLabels(BaseString[] value)
```
    Sets the predefined labels.
    
    Parameters:
    
    value - the labels
  - getPredefinedLabels
```
public BaseString[] getPredefinedLabels()
```
    Returns the predefined labels.
    
    Returns:
    
    the labels
  - predefinedLabelsTipText
```
public String predefinedLabelsTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - doDraw
```
protected abstract String doDraw(BufferedImageContainer image,
                                 List<Polygon> locations)
```
    Performs the actual drawing of the objects.
    
    Parameters:
    
    image - the image
    
    locations - the locations to paint
    
    Returns:
    
    null if OK, otherwise error message
  - doDraw
```
protected String doDraw(BufferedImageContainer image)
```
    Performs the actual draw operation.
    
    Specified by:
    
    doDraw in class AbstractDrawOperation
    
    Parameters:
    
    image - the image to draw on
    
    Returns:
    
    null if OK, otherwise error message

Class AbstractDrawObjectsFromReport

Field Summary

Fields inherited from class adams.flow.transformer.draw.AbstractDrawOperation

Fields inherited from class adams.core.option.AbstractOptionHandler

Fields inherited from class adams.core.logging.LoggingObject

Constructor Summary

Method Summary

Methods inherited from class adams.flow.transformer.draw.AbstractDrawOperation

Methods inherited from class adams.core.option.AbstractOptionHandler

Methods inherited from class adams.core.logging.LoggingObject

Methods inherited from class java.lang.Object

Methods inherited from interface adams.core.logging.LoggingLevelHandler

Field Detail

m_Overlays

Constructor Detail

AbstractDrawObjectsFromReport

Method Detail

defineOptions

initialize

setPrefix

getPrefix

prefixTipText

setColor

getColor

colorTipText

setUseColorsPerType

getUseColorsPerType

useColorsPerTypeTipText

setTypeColorProvider

getTypeColorProvider

typeColorProviderTipText

setTypeSuffix

getTypeSuffix

typeSuffixTipText

setTypeRegExp

getTypeRegExp

typeRegExpTipText

setLabelFormat

getLabelFormat

labelFormatTipText

setLabelFont

getLabelFont

labelFontTipText

setLabelAnchor

getLabelAnchor

labelAnchorTipText

setLabelOffsetX

getLabelOffsetX

labelOffsetXTipText

setLabelOffsetY

getLabelOffsetY

labelOffsetYTipText

setPredefinedLabels

getPredefinedLabels

predefinedLabelsTipText

doDraw

doDraw