Class/Object

ksb.csle.didentification.privacy

HidingOperator

Related Docs: object HidingOperator | package privacy

Permalink

class HidingOperator extends BasePrivacyAnonymizer

:: ApplicationDeveloperApi ::

Operator that implements the hiding module in the Data Suppression algorithm. It replaces (or hides) the values of the data with some statistic values such as min, max, or avg. Compared with aggregation module, which is only applicable to numerical data, this module can be applied on string data containing numerical values such as 20K, $40.

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. HidingOperator
  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 HidingOperator(o: StreamOperatorInfo)

    Permalink

    o

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

    • selectedColumnId: Column ID to apply the hiding function
    • method: how to hide the given data.
    • isDataRange: whether to replace the given data to statistic or range of interval
    • fieldInfo: the info about column attributes (identifier, sensitive, ..)
    • check: the method how to verify the performance of anonymized data

    HidingInfo

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

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 anonymize(src: DataFrame, columnNames: Array[String]): DataFrame

    Permalink
    Definition Classes
    BasePrivacyAnonymizer
  5. 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
  6. def anonymizeColumn(src: DataFrame, columnName: String): DataFrame

    Permalink

    Anonymizes the column in src dataframe using 'hidingType' method.

    Anonymizes the column in src dataframe using 'hidingType' method. - If the data range mode is on, call the DataRange module internally - If the specified column is numerical type, then this function calls the function in the Aggregation module internally. - If the specified column is only string type, it calls the function in the RecordReduction module internally. - If the specified column is both numeric and string mixed, it separates the numeric values and applies the hiding function only on them. And then, it combines the above hiding values and separated string.

    src

    Dataframe to anonymize

    columnName

    Column to be anonymized

    returns

    DataFrame Anonymized dataframe

    Definition Classes
    HidingOperatorBasePrivacyAnonymizer
  7. final def asInstanceOf[T0]: T0

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  13. 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
  14. 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
  15. def getQuasiColumnIDs(fieldInfos: Array[FieldInfo]): Array[Int]

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  19. def hidingNumericStringColumn[T](src: DataFrame, columnName: String, hidingType: T): DataFrame

    Permalink

    Hides the column containing both numerical and string values in src dataframe using 'aggrType' method.

    Hides the column containing both numerical and string values in src dataframe using 'aggrType' method.

    src

    Dataframe to anonymize

    columnName

    Column to be anonymized

    hidingType

    Methods to hide. ex., min, max, avg, and std

    returns

    DataFrame Anonymized dataframe

  20. def hidingStringColumn(src: DataFrame, columnName: String): DataFrame

    Permalink

    Hides the column containing only string values in src dataframe.

    Hides the column containing only string values in src dataframe.

    src

    Dataframe to anonymize

    columnName

    Column to be anonymized

    returns

    DataFrame Anonmized dataframe

  21. def hidingStringColumn[T](src: DataFrame, columnName: String, hidingType: T): DataFrame

    Permalink

    Hides the string column using 'aggrType' method.

    Hides the string column using 'aggrType' method. The values in this column may be comprised of string only, or of both numerical and string mixed.

    src

    Dataframe to anonymize

    columnName

    Column to be anonymized

    hidingType

    Methods to hide. ex., min, max, avg, and std

  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. 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
  24. 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
  25. val logger: Logger

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

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

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

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

    Permalink

    Operates hiding module for basic de-identification

    Operates hiding module for basic de-identification

    df

    Input dataframe

    returns

    DataFrame Anonymized dataframe

    Definition Classes
    HidingOperator → BaseGenericOperator → BaseGenericMutantOperator
  30. val p: HidingInfo

    Permalink
  31. val privacy: PrivacyCheckInfo

    Permalink
    Definition Classes
    BasePrivacyAnonymizer
  32. def stop: Unit

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. 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