Class/Object

ksb.csle.didentification.privacy

AggregationOperator

Related Docs: object AggregationOperator | package privacy

Permalink

class AggregationOperator extends BasePrivacyAnonymizer

:: ApplicationDeveloperApi ::

Operator that implements the aggregation module in the Aggregation algorithm. It replaces the values of the data with some statistic values such as min, max, avg, std, or count. If the type of record is string containing numerical value, this module extracts only numerical value and then applies this function on it.

Linear Supertypes
BasePrivacyAnonymizer, DataFrameCheck, BaseDataOperator[StreamOperatorInfo, DataFrame], BaseGenericOperator[StreamOperatorInfo, DataFrame], BaseGenericMutantOperator[StreamOperatorInfo, DataFrame, DataFrame], BaseDoer, Logging, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AggregationOperator
  2. BasePrivacyAnonymizer
  3. DataFrameCheck
  4. BaseDataOperator
  5. BaseGenericOperator
  6. BaseGenericMutantOperator
  7. BaseDoer
  8. Logging
  9. Serializable
  10. Serializable
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AggregationOperator(o: StreamOperatorInfo)

    Permalink

    o

    Object that contains message ksb.csle.common.proto.StreamDidentProto.AggregationInfo AggregationInfo contains attributes as follows:

    • selectedColumnId: Column ID to apply the aggregation function
    • method: the method to aggregate the given columns
    • fieldInfo: the info about column attributes (identifier, sensitive, ..)
    • check: the method how to verify the performance of anonymized data

    AggregationInfo

    enum AggregationMethod {
      MIN = 0;
      AVG = 1;
      MAX = 2;
      STD = 3;
      COUNT = 4;
      MANUAL = 5;
    }
    message AggregationInfo {
      repeated int32 selectedColumnId = 1;
      required AggregationMethod method = 2 [default = AVG];
      repeated FieldInfo fieldInfo = 3;
      optional PrivacyCheckInfo check = 4;
    }

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. def aggregateNumericColumn[T](src: DataFrame, columnName: String, aggrType: T): DataFrame

    Permalink

    Replaces the values of the column containing numerical data with statistic information using 'aggrType' method such as min, max, avg, std, and count

    Replaces the values of the column containing numerical data with statistic information using 'aggrType' method such as min, max, avg, std, and count

    src

    Dataframe to anonymize

    columnName

    Column to be anonymized

    aggrType

    Methods of aggregation module. ex., min, max, avg, std, and count

    returns

    DataFrame Anonymized dataframe

  5. def anonymize(src: DataFrame, columnNames: Array[String]): DataFrame

    Permalink
    Definition Classes
    BasePrivacyAnonymizer
  6. def anonymize(src: DataFrame, columnName: String): DataFrame

    Permalink

    Anonymizes the column specified in src dataframe using generic 'Type' method.

    Anonymizes the column specified in src dataframe using generic 'Type' method. The 'Type' is decided by inherited object module.

    src

    Dataframe to anonymize

    columnName

    Column to be anonymized

    returns

    DataFrame The dataframe which replaces original column with anonymized column

    Definition Classes
    BasePrivacyAnonymizer
  7. def anonymizeColumn(src: DataFrame, columnName: String): DataFrame

    Permalink

    Replaces the values of the column with statistic information using 'aggrType' method such as min, max, avg, std, and count.

    Replaces the values of the column with statistic information using 'aggrType' method such as min, max, avg, std, and count. If the type of column is string, this module call the hiding module internally.

    src

    Dataframe to anonymize

    columnName

    Column to be anonymized

    returns

    DataFrame Anonymized dataframe

    Definition Classes
    AggregationOperatorBasePrivacyAnonymizer
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def clone(): AnyRef

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  14. def getColumnName(src: DataFrame, columnId: Int): String

    Permalink

    Returns column name from src dataframe specified by the column ID defined by protobuf.

    Returns column name from src dataframe specified by the column ID defined by protobuf.

    src

    dataframe to get names of columns.

    columnId

    column ID to anonymize.

    returns

    String.

    Definition Classes
    DataFrameCheck
  15. def getColumnNames(src: DataFrame, columnIDs: Array[Int]): Array[String]

    Permalink

    Returns column names from src dataframe specified by column IDs.

    Returns column names from src dataframe specified by column IDs. Note that the column with invalid IDs are ignored.

    src

    dataframe to get names of columns.

    returns

    Array[String].

    Definition Classes
    DataFrameCheck
  16. def getQuasiColumnIDs(fieldInfos: Array[FieldInfo]): Array[Int]

    Permalink
    Definition Classes
    DataFrameCheck
  17. def getSensColumnIDs(fieldInfos: Array[FieldInfo]): Array[Int]

    Permalink
    Definition Classes
    DataFrameCheck
  18. def getValidColumnIDs(src: DataFrame, columnIDs: Array[Int]): Array[Int]

    Permalink
    Definition Classes
    DataFrameCheck
  19. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  21. def isValidColumnID(src: DataFrame, columnID: Int): Boolean

    Permalink

    Checks the given column ID is valid.

    Checks the given column ID is valid.

    src

    dataframe to get names of columns.

    returns

    Boolean.

    Definition Classes
    DataFrameCheck
  22. def isValidColumnName(src: DataFrame, columnName: String): Boolean

    Permalink

    Checks the given column Name is valid.

    Checks the given column Name is valid.

    src

    dataframe to get names of columns.

    columnName

    column Name.

    returns

    Boolean.

    Definition Classes
    DataFrameCheck
  23. val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  24. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  25. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  27. def operate(df: DataFrame): DataFrame

    Permalink

    Operates aggregation module for basic de-identification

    Operates aggregation module for basic de-identification

    df

    Input dataframe

    returns

    DataFrame Anonymized dataframe

    Definition Classes
    AggregationOperator → BaseGenericOperator → BaseGenericMutantOperator
  28. val p: AggregationInfo

    Permalink
  29. val privacy: PrivacyCheckInfo

    Permalink
    Definition Classes
    BasePrivacyAnonymizer
  30. def stop: Unit

    Permalink
    Definition Classes
    BaseGenericOperator → BaseGenericMutantOperator
  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  32. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from BasePrivacyAnonymizer

Inherited from DataFrameCheck

Inherited from BaseDataOperator[StreamOperatorInfo, DataFrame]

Inherited from BaseGenericOperator[StreamOperatorInfo, DataFrame]

Inherited from BaseGenericMutantOperator[StreamOperatorInfo, DataFrame, DataFrame]

Inherited from BaseDoer

Inherited from Logging

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped