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

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, ObjectPrefixHandler, Serializable
```
public class ObjectAnnotationsFromReport
extends AbstractDrawOperation
implements ObjectPrefixHandler
```
Overlays object annotations from the report.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected LocatedObjects`	`m_Annotations`	the annotations.
`protected AnnotationCleaner[]`	`m_Cleaners`	the cleaners to use.
`protected AnnotationColors[]`	`m_LabelColors`	the colorizers for the labels.
`protected LabelPlotter[]`	`m_LabelPlotters`	the label plotters.
`protected AnnotationColors[]`	`m_OutlineColors`	the colorizers for the outline.
`protected OutlinePlotter[]`	`m_OutlinePlotters`	the outline plotters.
`protected String`	`m_Prefix`	the prefix to use.
`protected AnnotationColors[]`	`m_ShapeColors`	the colorizers for the shape.
`protected ShapePlotter[]`	`m_ShapePlotters`	the shape plotters.

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

ObjectAnnotationsFromReport()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`cleanersTipText()`	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.
`AnnotationCleaner[]`	`getCleaners()`	Returns the cleaners for the annotations.
`AnnotationColors[]`	`getLabelColors()`	Returns the colorizers for the label plotters.
`LabelPlotter[]`	`getLabelPlotters()`	Returns the plotters for the labels.
`AnnotationColors[]`	`getOutlineColors()`	Returns the colorizers for the outline plotters.
`OutlinePlotter[]`	`getOutlinePlotters()`	Returns the plotters for the outlines.
`String`	`getPrefix()`	Returns the field prefix used in the report.
`AnnotationColors[]`	`getShapeColors()`	Returns the colorizers for the shape plotters.
`ShapePlotter[]`	`getShapePlotters()`	Returns the plotters for the shapes.
`String`	`globalInfo()`	Returns a string describing the object.
`protected void`	`initAnnotations(Report report)`	Initializes the annotations.
`String`	`labelColorsTipText()`	Returns the tip text for this property.
`String`	`labelPlottersTipText()`	Returns the tip text for this property.
`String`	`outlineColorsTipText()`	Returns the tip text for this property.
`String`	`outlinePlottersTipText()`	Returns the tip text for this property.
`String`	`prefixTipText()`	Returns the tip text for this property.
`protected void`	`reset()`	Resets the scheme.
`void`	`setCleaners(AnnotationCleaner[] value)`	Sets the cleaners for the annotations.
`void`	`setLabelColors(AnnotationColors[] value)`	Sets the colorizers for the label plotters.
`void`	`setLabelPlotters(LabelPlotter[] value)`	Sets the plotters for the labels.
`void`	`setOutlineColors(AnnotationColors[] value)`	Sets the colorizers for the outline plotters.
`void`	`setOutlinePlotters(OutlinePlotter[] value)`	Sets the plotters for the outlines.
`void`	`setPrefix(String value)`	Sets the field prefix used in the report.
`void`	`setShapeColors(AnnotationColors[] value)`	Sets the colorizers for the shape plotters.
`void`	`setShapePlotters(ShapePlotter[] value)`	Sets the plotters for the shapes.
`String`	`shapeColorsTipText()`	Returns the tip text for this property.
`String`	`shapePlottersTipText()`	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, initialize, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel

- Field Detail
  - m_Prefix
```
protected String m_Prefix
```
    the prefix to use.
  - m_Cleaners
```
protected AnnotationCleaner[] m_Cleaners
```
    the cleaners to use.
  - m_ShapePlotters
```
protected ShapePlotter[] m_ShapePlotters
```
    the shape plotters.
  - m_ShapeColors
```
protected AnnotationColors[] m_ShapeColors
```
    the colorizers for the shape.
  - m_OutlinePlotters
```
protected OutlinePlotter[] m_OutlinePlotters
```
    the outline plotters.
  - m_OutlineColors
```
protected AnnotationColors[] m_OutlineColors
```
    the colorizers for the outline.
  - m_LabelPlotters
```
protected LabelPlotter[] m_LabelPlotters
```
    the label plotters.
  - m_LabelColors
```
protected AnnotationColors[] m_LabelColors
```
    the colorizers for the labels.
  - m_Annotations
```
protected transient LocatedObjects m_Annotations
```
    the annotations.
- Constructor Detail
  - ObjectAnnotationsFromReport
```
public ObjectAnnotationsFromReport()
```
- 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 AbstractOptionHandler
  - reset
```
protected void reset()
```
    Resets the scheme.
    
    Overrides:
    
    reset in class AbstractOptionHandler
  - setPrefix
```
public void setPrefix(String value)
```
    Sets the field prefix used in the report.
    
    Specified by:
    
    setPrefix in interface ObjectPrefixHandler
    
    Parameters:
    
    value - the field prefix
  - getPrefix
```
public String getPrefix()
```
    Returns the field prefix used in the report.
    
    Specified by:
    
    getPrefix in interface ObjectPrefixHandler
    
    Returns:
    
    the field prefix
  - prefixTipText
```
public String prefixTipText()
```
    Returns the tip text for this property.
    
    Specified by:
    
    prefixTipText in interface ObjectPrefixHandler
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setCleaners
```
public void setCleaners(AnnotationCleaner[] value)
```
    Sets the cleaners for the annotations.
    
    Parameters:
    
    value - the cleaners
  - getCleaners
```
public AnnotationCleaner[] getCleaners()
```
    Returns the cleaners for the annotations.
    
    Returns:
    
    the cleaners
  - cleanersTipText
```
public String cleanersTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setShapeColors
```
public void setShapeColors(AnnotationColors[] value)
```
    Sets the colorizers for the shape plotters.
    
    Parameters:
    
    value - the colorizers
  - getShapeColors
```
public AnnotationColors[] getShapeColors()
```
    Returns the colorizers for the shape plotters.
    
    Returns:
    
    the colorizers
  - shapeColorsTipText
```
public String shapeColorsTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setShapePlotters
```
public void setShapePlotters(ShapePlotter[] value)
```
    Sets the plotters for the shapes.
    
    Parameters:
    
    value - the plotters
  - getShapePlotters
```
public ShapePlotter[] getShapePlotters()
```
    Returns the plotters for the shapes.
    
    Returns:
    
    the plotters
  - shapePlottersTipText
```
public String shapePlottersTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setOutlineColors
```
public void setOutlineColors(AnnotationColors[] value)
```
    Sets the colorizers for the outline plotters.
    
    Parameters:
    
    value - the colorizers
  - getOutlineColors
```
public AnnotationColors[] getOutlineColors()
```
    Returns the colorizers for the outline plotters.
    
    Returns:
    
    the colorizers
  - outlineColorsTipText
```
public String outlineColorsTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setOutlinePlotters
```
public void setOutlinePlotters(OutlinePlotter[] value)
```
    Sets the plotters for the outlines.
    
    Parameters:
    
    value - the plotters
  - getOutlinePlotters
```
public OutlinePlotter[] getOutlinePlotters()
```
    Returns the plotters for the outlines.
    
    Returns:
    
    the plotters
  - outlinePlottersTipText
```
public String outlinePlottersTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setLabelColors
```
public void setLabelColors(AnnotationColors[] value)
```
    Sets the colorizers for the label plotters.
    
    Parameters:
    
    value - the colorizers
  - getLabelColors
```
public AnnotationColors[] getLabelColors()
```
    Returns the colorizers for the label plotters.
    
    Returns:
    
    the colorizers
  - labelColorsTipText
```
public String labelColorsTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setLabelPlotters
```
public void setLabelPlotters(LabelPlotter[] value)
```
    Sets the plotters for the labels.
    
    Parameters:
    
    value - the plotters
  - getLabelPlotters
```
public LabelPlotter[] getLabelPlotters()
```
    Returns the plotters for the labels.
    
    Returns:
    
    the plotters
  - labelPlottersTipText
```
public String labelPlottersTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - initAnnotations
```
protected void initAnnotations(Report report)
```
    Initializes the annotations.
    
    Parameters:
    
    report - the report to get the annotations from
  - 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 ObjectAnnotationsFromReport

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_Prefix

m_Cleaners

m_ShapePlotters

m_ShapeColors

m_OutlinePlotters

m_OutlineColors

m_LabelPlotters

m_LabelColors

m_Annotations

Constructor Detail

ObjectAnnotationsFromReport

Method Detail

globalInfo

defineOptions

reset

setPrefix

getPrefix

prefixTipText

setCleaners

getCleaners

cleanersTipText

setShapeColors

getShapeColors

shapeColorsTipText

setShapePlotters

getShapePlotters

shapePlottersTipText

setOutlineColors

getOutlineColors

outlineColorsTipText

setOutlinePlotters

getOutlinePlotters

outlinePlottersTipText

setLabelColors

getLabelColors

labelColorsTipText

setLabelPlotters

getLabelPlotters

labelPlottersTipText

initAnnotations

doDraw