Value Members

1.  final def !=(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

2.  final def ##(): Int

   Definition Classes

   AnyRef → Any

3.  final def ==(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

4.  final def asInstanceOf[T0]: T0

   Definition Classes

   Any

5.  def clone(): AnyRef

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @native() @throws( ... )

6.  val col: String
7.  var colsMap: Map[String, IndexField]

   Definition Classes

   Index

8.  final def eq(arg0: AnyRef): Boolean

   Definition Classes

   AnyRef

9.  def finalize(): Unit

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( classOf[java.lang.Throwable] )

10.  def generateBaseMetadata(): MetadataType
    returns

    "zero" value of the index - will be used for the first comparison to the object's rows data (by default this is null)

    Definition Classes

    Index

11.  def generateColsMap(schemaMap: Map[String, (String, StructField)]): Unit

    Generate the column map according to a given schema

    Generate the column map according to a given schema

    schemaMap

    a map containing column names (as appear in the object) and their data types the key is the column name in lower case

    Definition Classes

    Index

12.  final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

13.  def getCols: Seq[String]
    returns

    the index columns (in lower case)

    Definition Classes

    Index

14.  def getIndexCols: Iterable[IndexField]
    returns

    the columns which the indexed is defined on

    Definition Classes

    Index

15.  def getKeyMetadata(): Option[String]

    Definition Classes

    Index

16.  def getMetaDataTypeClassName(): String
    returns

    the (full) name of the MetaDataType class used by this index

    Definition Classes

    MinMaxIndex → Index

17.  def getName: String
    returns

    the name of the index

    Definition Classes

    MinMaxIndex → Index

18.  def getParams: Map[String, String]
    returns

    the index params map

    Definition Classes

    Index

19.  def getRowMetadata(row: Row): Any

    Gets a DataFrame row and extract the raw metadata needed by the index

    Gets a DataFrame row and extract the raw metadata needed by the index

    row

    Row a row to be indexed

    returns

    raw metadata needed by the index or null if the row contain null value

    Definition Classes

    MinMaxIndex → Index

20.  val indexCols: Seq[String]

    Definition Classes

    Index

21.  def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Attributes

    protected

    Definition Classes

    Logging

22.  def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Attributes

    protected

    Definition Classes

    Logging

23.  def isEncrypted(): Boolean

    Definition Classes

    Index

24.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

25.  var isOptimized: Boolean

    Definition Classes

    Index

26.  def isTraceEnabled(): Boolean

    Attributes

    protected

    Definition Classes

    Logging

27.  def isValid(df: DataFrame, schemaMap: Map[String, (String, DataType)]): Unit

    Gets a DataFrame and checks whether it is valid for the index

    Gets a DataFrame and checks whether it is valid for the index

    df

    the DataFrame to be checked

    schemaMap

    a map containing column names (as appear in the object) and their data types the key is the column name in lower case

    Definition Classes

    MinMaxIndex → Index

    Exceptions thrown

    [[XskipperException]] if invalid index

28.  val keyMetadata: Option[String]
29.  def log: Logger

    Attributes

    protected

    Definition Classes

    Logging

30.  def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Attributes

    protected

    Definition Classes

    Logging

31.  def logDebug(msg: ⇒ String): Unit

    Attributes

    protected

    Definition Classes

    Logging

32.  def logError(msg: ⇒ String, throwable: Throwable): Unit

    Attributes

    protected

    Definition Classes

    Logging

33.  def logError(msg: ⇒ String): Unit

    Attributes

    protected

    Definition Classes

    Logging

34.  def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Attributes

    protected

    Definition Classes

    Logging

35.  def logInfo(msg: ⇒ String): Unit

    Attributes

    protected

    Definition Classes

    Logging

36.  def logName: String

    Attributes

    protected

    Definition Classes

    Logging

37.  def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Attributes

    protected

    Definition Classes

    Logging

38.  def logTrace(msg: ⇒ String): Unit

    Attributes

    protected

    Definition Classes

    Logging

39.  def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Attributes

    protected

    Definition Classes

    Logging

40.  def logWarning(msg: ⇒ String): Unit

    Attributes

    protected

    Definition Classes

    Logging

41.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

42.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

43.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

44.  def optCollectMetaData(filePath: String, df: DataFrame, format: String, options: Map[String, String]): MetadataType

    For some formats we might have an optimized way for collecting the metadata This function enables this by receiving the entire file DataFrame instead of processing it row by row (For example in Parquet we can read the min/max from the footer)

    For some formats we might have an optimized way for collecting the metadata This function enables this by receiving the entire file DataFrame instead of processing it row by row (For example in Parquet we can read the min/max from the footer)

    filePath

    the path of the file that is being processed

    df

    a DataFrame with the file data

    format

    the format of the file

    options

    the options that were used to read the file

    returns

    the collected MetadataType or null if no metadata was collected

    Definition Classes

    Index

45.  def reduce(accuMetadata: MetadataType, curr: Any): MetadataType

    Given an accumulated metadata and new value - process the new value and returns an updated accumulated metadata

    Given an accumulated metadata and new value - process the new value and returns an updated accumulated metadata

    accuMetadata

    accumulated metadata created by processing all values until curr

    curr

    new value to be processed

    returns

    updated metadata for the index

    Definition Classes

    MinMaxIndex → Index

46.  def reduce(md1: MetadataType, md2: MetadataType): MetadataType

    Same as above reduce given two accumulated metadata

    Same as above reduce given two accumulated metadata

    returns

    updated metadata for the index

    Definition Classes

    MinMaxIndex → Index

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

    Definition Classes

    AnyRef

48.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

49.  final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

50.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @native() @throws( ... )