com.alpine.plugin.core.utils

AddendumWriter

object AddendumWriter

Utilities for writing the addendum for custom operators in a consistent manner

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AddendumWriter
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. val OUTPUT_DISPLAY_NAME: String

  7. val SUMMARY_DISPLAY_NAME: String

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def createCompositeVisualModel[O <: TabularDataset](visualModelFactory: VisualModelFactory, outputData: O, additionalVisualModels: Array[(String, VisualModel)] = Array.empty[(String, VisualModel)]): CompositeVisualModel

    Use in the 'OnOutputVisualization class.

    Use in the 'OnOutputVisualization class. Creates a composite visualization with - the output of a tabular dataset - the visual models provided by the optional additionalVisualModels parameter - an HtmlVisualModel of the summary if it has been added to the addendum (nothing will be - added if the addendum doesn't include anything with the visual key 'summaryKey'

  11. def createStandardAddendum(summaryText: String): Map[String, AnyRef]

    Create a map which can be used as the addendum with one (key, value) pair added.

    Create a map which can be used as the addendum with one (key, value) pair added. Add more values to the map with map.updated(newKey, newValue)

    summaryText

    The text which should appear in the summary tab of the result output.

    returns

  12. val emptyRow: List[String]

    Add to a list that will be used by Tabulator.

    Add to a list that will be used by Tabulator. It creates an empty row in the table

  13. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def generateBadDataReport(inputSize: Long, outputSize: Long): List[List[String]]

    Given the input size and output size, generates a report as a list of lists (which can then be formatted as an HTML table with the tabulator class about how much bad data was removed.

    Given the input size and output size, generates a report as a list of lists (which can then be formatted as an HTML table with the tabulator class about how much bad data was removed. If, for example, the input had 100 rows and the output had ninety the report would read: Input data size: 100 rows Input data size after removing rows with null values: 90 rows Rows removed (due to null values) : 10 rows (10%)

  17. def generateNullDataReport(inputSize: Long, outputSize: Long, reason: String): List[List[String]]

    Given the input size and output size, generates a report as a list of lists (which can then be formatted as an HTML table with the tabulator class about how much bad data was removed.

    Given the input size and output size, generates a report as a list of lists (which can then be formatted as an HTML table with the tabulator class about how much bad data was removed. If, for example, the input had 100 rows and the output had ninety the report would read: Input data size: 100 rows Input data size after removing rows + REASON + : 90 rows Rows removed (REASON) : 10 rows (10%)

    inputSize
    outputSize
    reason

    - why the data was removed e.g. "due to null values"

    returns

  18. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  24. def reportBadDataSize(input: Long, output: Long): List[String]

  25. def reportInputSize(n: Long): List[String]

  26. def reportNullDataSize(input: Long, output: Long, reason: String): List[String]

  27. def reportOutputLocation(outputPath: String, resultMessage: String = ...): String

    Returns a string describing the name of the results and where they are stored.

    Returns a string describing the name of the results and where they are stored. Has html
    tags afterwards.

  28. def reportOutputSize(n: Long, reason: String): List[String]

  29. def reportOutputSize(n: Long): List[String]

  30. val summaryKey: String

  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  32. def toString(): String

    Definition Classes
    AnyRef → Any
  33. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped