Class ExportFeaturesStyle

Object
AnchorBean<ExportFeaturesStyle>
ExportFeaturesStyle
public class ExportFeaturesStyle extends AnchorBean<ExportFeaturesStyle>
Visual style for how features are exported.
Author:
Owen Feehan

  • Constructor Summary

    Constructors
    Constructor
    Description
    ExportFeaturesStyle()
     
    ExportFeaturesStyle(boolean removeNaNColumns, boolean visuallyShortenDecimals, boolean suppressErrors)
    Creates a new ExportFeaturesStyle instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    FeatureExporterContext
    deriveContext(InputOutputContext context)
    Derives a FeatureExporterContext from the current style and given context.
    boolean
    isRemoveNaNColumns()
    When true, columns containing all Double.NaN values are removed before outputting.
    boolean
    isSuppressErrors()
    When false, an image is reported as errored, if any exception is thrown during calculation.
    boolean
    isVisuallyShortenDecimals()
    When true, feature-values are shown as visually compressed as possible, including suppressing decimal places.
    void
    setRemoveNaNColumns(boolean removeNaNColumns)
    When true, columns containing all Double.NaN values are removed before outputting.
    void
    setSuppressErrors(boolean suppressErrors)
    When false, an image is reported as errored, if any exception is thrown during calculation.
    void
    setVisuallyShortenDecimals(boolean visuallyShortenDecimals)
    When true, feature-values are shown as visually compressed as possible, including suppressing decimal places.

    Methods inherited from class org.anchoranalysis.bean.AnchorBean

    checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ExportFeaturesStyle

      public ExportFeaturesStyle()

    • ExportFeaturesStyle

      public ExportFeaturesStyle(boolean removeNaNColumns, boolean visuallyShortenDecimals, boolean suppressErrors)
      Creates a new ExportFeaturesStyle instance.
      Parameters:
      removeNaNColumns - When true, columns containing all Double.NaN values are removed before outputting.

      When false, all columns are included.

      visuallyShortenDecimals - When true, feature-values are shown as visually compressed as possible, including suppressing decimal places.

      When false, a fixed number of decimal places is shown for all feature-values.

      e.g. when true, 2 is shown instead of 2.0000000000 or 6.71 instead of 6.71000000000000

      suppressErrors - When false, an image is reported as errored, if any exception is thrown during calculation.

      When true, then a value of Double.NaN is returned, and a message is written to the error-log.

  • Method Details

    • deriveContext

      public FeatureExporterContext deriveContext(InputOutputContext context)
      Derives a FeatureExporterContext from the current style and given context.
      Parameters:
      context - the InputOutputContext to use for deriving the new context.
      Returns:
      a new FeatureExporterContext instance.

    • isRemoveNaNColumns

      public boolean isRemoveNaNColumns()
      When true, columns containing all Double.NaN values are removed before outputting.

      When false, all columns are included.

    • setRemoveNaNColumns

      public void setRemoveNaNColumns(boolean removeNaNColumns)
      When true, columns containing all Double.NaN values are removed before outputting.

      When false, all columns are included.

    • isVisuallyShortenDecimals

      public boolean isVisuallyShortenDecimals()
      When true, feature-values are shown as visually compressed as possible, including suppressing decimal places.

      When false, a fixed number of decimal places is shown for all feature-values.

      e.g. when true, 2 is shown instead of 2.0000000000 or 6.71 instead of 6.71000000000000

    • setVisuallyShortenDecimals

      public void setVisuallyShortenDecimals(boolean visuallyShortenDecimals)
      When true, feature-values are shown as visually compressed as possible, including suppressing decimal places.

      When false, a fixed number of decimal places is shown for all feature-values.

      e.g. when true, 2 is shown instead of 2.0000000000 or 6.71 instead of 6.71000000000000

    • isSuppressErrors

      public boolean isSuppressErrors()
      When false, an image is reported as errored, if any exception is thrown during calculation.

      When true, then a value of Double.NaN is returned, and a message is written to the error-log.

    • setSuppressErrors

      public void setSuppressErrors(boolean suppressErrors)
      When false, an image is reported as errored, if any exception is thrown during calculation.

      When true, then a value of Double.NaN is returned, and a message is written to the error-log.