com.alpine.plugin.core.visualization

VisualModelFactory

trait VisualModelFactory extends AnyRef

:: AlpineSdkApi ::

Annotations
@AlpineSdkApi()
Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. VisualModelFactory
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def createDBTableVisualization(schemaName: String, tableName: String): VisualModel

    Create a visualization for a DB table.

    Create a visualization for a DB table. This pulls a preview of the DB table, for display in the results console.

    schemaName

    The schema name of the table to preview.

    tableName

    The schema name of the table to preview.

    returns

    A visualization of a sample of the table.

  2. abstract def createDBTableVisualization(dbTable: DBTable): VisualModel

    Create a visualization for a DB table.

    Create a visualization for a DB table. This pulls a preview of the DB table, for display in the results console. Equivalent to dbTable.tableName)

    dbTable

    A DB table that we want to visualize.

    returns

    A visualization of the sample.

  3. abstract def createDefaultVisualModel(ioObject: IOBase): VisualModel

    Create the default visual model for the given IOBase object.

    Create the default visual model for the given IOBase object. This is useful to quickly generate a visual model for an existing IOBase object.

    ioObject

    The IOBase object that we want to create a visual model for.

    returns

    A matching visual model.

  4. abstract def createPlainTextVisualModel(hdfsFile: HdfsFile): TextVisualModel

    Gets the first few lines of the HdfsFile as plain text.

    Gets the first few lines of the HdfsFile as plain text.

    hdfsFile

    The file to preview.

    returns

    The first few lines of the file as a visual model.

  5. abstract def createTabularDatasetVisualization(dataset: TabularDataset): VisualModel

    Create a visualization for an Hdfs tabular dataset.

    Create a visualization for an Hdfs tabular dataset.

    dataset

    A Hdfs tabular dataset that we want to visualize.

    returns

    A visualization of the sample.

  6. abstract def locale: Locale

  7. abstract def createCompositeVisualModel(): CompositeVisualModel

    One can return a composite of multiple visualizations.

    One can return a composite of multiple visualizations.

    returns

    A composite visual model that can contain multiple visualizations.

    Annotations
    @deprecated
    Deprecated

    Use CompositeVisualModel directly instead.

  8. abstract def createHtmlTextVisualization(text: String): VisualModel

    Create a visualization of an HTML text element.

    Create a visualization of an HTML text element. Use this method rather than the 'createTextVisualization' method if you want to include HTML formatting elements (like a table, or bold text) in your visualization.

    text

    An HTML String

    returns

    A text visualization object, which puts the html text inside of a <text> tag.

    Annotations
    @deprecated
    Deprecated

    Use HtmlVisualModel directly instead.

  9. abstract def createTextVisualization(text: String): VisualModel

    Create a simple text content visualization.

    Create a simple text content visualization.

    text

    The text we want to display in the console.

    returns

    A text visualization object.

    Annotations
    @deprecated
    Deprecated

    Use TextVisualModel directly instead.

Concrete 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. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

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

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

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

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

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

    Definition Classes
    AnyRef
  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  18. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped