# Uses of Class org.deidentifier.arx.ARXConfiguration (ARX GUI Documentation)

## Uses of Class
org.deidentifier.arx.ARXConfiguration

- Packages that use ARXConfiguration
  Package | Description
  --- | ---
  org.deidentifier.arx | This package provides the public API for the ARX anonymization framework.
  org.deidentifier.arx.certificate |
  org.deidentifier.arx.criteria | This package implements different variants of class-based privacy criteria, such as k-anonymity, l-diversity, t-closeness and d-presence.
  org.deidentifier.arx.gui.model |
  org.deidentifier.arx.gui.worker |
  org.deidentifier.arx.metric | This package implements several metrics for information loss.
  org.deidentifier.arx.metric.v2 |
  org.deidentifier.arx.risk | This package provides methods for risk analyses

- - ### Uses of ARXConfiguration in org.deidentifier.arx

    Methods in org.deidentifier.arx that return ARXConfiguration
    Modifier and Type | Method and Description
    --- | ---
    `ARXConfiguration` | ARXConfiguration.`addCriterion(PrivacyCriterion c)` Deprecated.
    `ARXConfiguration` | ARXConfiguration.`addPrivacyModel(PrivacyCriterion c)` Adds a privacy model to the configuration.
    `ARXConfiguration` | ARXConfiguration.`clone()` Clones this config.
    `static ARXConfiguration` | ARXConfiguration.`create()` Creates a new configuration without tuple suppression.
    `static ARXConfiguration` | ARXConfiguration.`create(double suppressionLimit)` Creates a new configuration that allows the given percentage of outliers and thus implements tuple suppression.
    `static ARXConfiguration` | ARXConfiguration.`create(double suppressionLimit, Metric<?> metric)` Creates a new configuration that allows the given percentage of outliers and thus implements tuple suppression.
    `static ARXConfiguration` | ARXConfiguration.`create(Metric<?> metric)` Creates a new configuration that allows to define the metric for measuring information loss.
    `protected abstract ARXConfiguration` | DataHandle.`getConfiguration()` Returns the ARXConfiguration that is currently being used, null if this is an input handle
    `ARXConfiguration` | ARXResult.`getConfiguration()` Returns the configuration used.
    `protected ARXConfiguration` | DataHandleInput.`getConfiguration()`
    `protected ARXConfiguration` | DataHandleOutput.`getConfiguration()`
    `protected ARXConfiguration` | DataHandleSubset.`getConfiguration()`
    `protected ARXConfiguration` | ARXConfiguration.`getInstanceForLocalRecoding(RowSet rowset, double gsFactor)` Clones this config and projects everything onto the given subset. - All privacy models will be cloned - Subsets in d-presence will be projected accordingly - Utility measures will be cloned - Replaces estimated k-map with according k-anonymity
    `ARXConfiguration` | ARXConfiguration.`setCostBenefitConfiguration(ARXCostBenefitConfiguration config)` Sets the cost/benefit configuration

    Methods in org.deidentifier.arx with parameters of type ARXConfiguration
    Modifier and Type | Method and Description
    --- | ---
    `ARXResult` | ARXAnonymizer.`anonymize(Data data, ARXConfiguration config)` Performs data anonymization.
    `protected org.deidentifier.arx.ARXAnonymizer.Result` | ARXAnonymizer.`anonymize(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, ARXConfiguration config)` Reset a previous lattice and run the algorithm .
    `void` | ARXLattice.Access.`setMonotonicity(ARXConfiguration config)` Accessor method

    Constructors in org.deidentifier.arx with parameters of type ARXConfiguration
    Constructor and Description
    `ARXConfiguration.ARXConfigurationInternal(ARXConfiguration config)` Creates a new instance.
    `ARXResult(DataHandle handle, DataDefinition definition, ARXLattice lattice, int historySize, double snapshotSizeSnapshot, double snapshotSizeDataset, Metric<?> metric, ARXConfiguration config, ARXLattice.ARXNode optimum, long time, org.deidentifier.arx.framework.lattice.SolutionSpace solutionSpace)` Internal constructor for deserialization.
    `ARXResult(org.deidentifier.arx.DataRegistry registry, org.deidentifier.arx.framework.data.DataManager manager, org.deidentifier.arx.framework.check.NodeChecker checker, DataDefinition definition, ARXConfiguration config, ARXLattice lattice, long duration, org.deidentifier.arx.framework.lattice.SolutionSpace solutionSpace)` Creates a new instance.
    `DataHandleOutput(ARXResult result, org.deidentifier.arx.DataRegistry registry, org.deidentifier.arx.framework.data.DataManager manager, org.deidentifier.arx.framework.data.Data outputGeneralized, org.deidentifier.arx.framework.data.Data outputMicroaggregated, ARXLattice.ARXNode node, DataDefinition definition, ARXConfiguration config)` Instantiates a new handle.

  - ### Uses of ARXConfiguration in org.deidentifier.arx.certificate

    Methods in org.deidentifier.arx.certificate with parameters of type ARXConfiguration
    Modifier and Type | Method and Description
    --- | ---
    `static ARXCertificate` | ARXCertificate.`create(DataHandle input, DataDefinition definition, ARXConfiguration config, ARXResult result, ARXLattice.ARXNode transformation, DataHandle output)` Creates a new instance
    `static ARXCertificate` | ARXCertificate.`create(DataHandle input, DataDefinition definition, ARXConfiguration config, ARXResult result, ARXLattice.ARXNode transformation, DataHandle output, CSVSyntax syntax)` Renders the document into the given output stream.
    `static ARXCertificate` | ARXCertificate.`create(DataHandle input, DataDefinition definition, ARXConfiguration config, ARXResult result, ARXLattice.ARXNode transformation, DataHandle output, CSVSyntax syntax, ElementData metadata)` Renders the document into the given output stream.

  - ### Uses of ARXConfiguration in org.deidentifier.arx.criteria

    Methods in org.deidentifier.arx.criteria with parameters of type ARXConfiguration
    Modifier and Type | Method and Description
    --- | ---
    `void` | KMap.`initialize(org.deidentifier.arx.framework.data.DataManager manager, ARXConfiguration config)`
    `void` | ProfitabilityProsecutorNoAttack.`initialize(org.deidentifier.arx.framework.data.DataManager manager, ARXConfiguration config)`
    `void` | EqualDistanceTCloseness.`initialize(org.deidentifier.arx.framework.data.DataManager manager, ARXConfiguration config)`
    `void` | PopulationUniqueness.`initialize(org.deidentifier.arx.framework.data.DataManager manager, ARXConfiguration config)`
    `void` | OrderedDistanceTCloseness.`initialize(org.deidentifier.arx.framework.data.DataManager manager, ARXConfiguration config)`
    `void` | ExplicitPrivacyCriterion.`initialize(org.deidentifier.arx.framework.data.DataManager manager, ARXConfiguration config)`
    `void` | Inclusion.`initialize(org.deidentifier.arx.framework.data.DataManager manager, ARXConfiguration config)`
    `void` | EDDifferentialPrivacy.`initialize(org.deidentifier.arx.framework.data.DataManager manager, ARXConfiguration config)` Creates a random sample based on beta
    `void` | EnhancedBLikeness.`initialize(org.deidentifier.arx.framework.data.DataManager manager, ARXConfiguration config)`
    `void` | DDisclosurePrivacy.`initialize(org.deidentifier.arx.framework.data.DataManager manager, ARXConfiguration config)`
    `void` | HierarchicalDistanceTCloseness.`initialize(org.deidentifier.arx.framework.data.DataManager manager, ARXConfiguration config)`
    `void` | BasicBLikeness.`initialize(org.deidentifier.arx.framework.data.DataManager manager, ARXConfiguration config)`
    `void` | PrivacyCriterion.`initialize(org.deidentifier.arx.framework.data.DataManager manager, ARXConfiguration config)` Override this to initialize the criterion.
    `void` | DPresence.`initialize(org.deidentifier.arx.framework.data.DataManager manager, ARXConfiguration config)`
    `void` | ProfitabilityProsecutor.`initialize(org.deidentifier.arx.framework.data.DataManager manager, ARXConfiguration config)`

  - ### Uses of ARXConfiguration in org.deidentifier.arx.gui.model

    Methods in org.deidentifier.arx.gui.model that return ARXConfiguration
    Modifier and Type | Method and Description
    --- | ---
    `ARXConfiguration` | ModelConfiguration.`addCriterion(PrivacyCriterion c)` Delegates to an instance of ARXConfiguration.
    `ARXConfiguration` | Model.`createSubsetConfig()` Creates an ARXConfiguration for the subset.
    `ARXConfiguration` | ModelConfiguration.`getConfig()` Returns the current config.

  - ### Uses of ARXConfiguration in org.deidentifier.arx.gui.worker

    Constructors in org.deidentifier.arx.gui.worker with parameters of type ARXConfiguration
    Constructor and Description
    `WorkerCreateCertificate(java.lang.String path, CSVSyntax syntax, DataHandle input, DataDefinition definition, ARXConfiguration config, ARXResult result, ARXLattice.ARXNode transformation, DataHandle output, Model model)` Creates a new instance.
    `WorkerExport(java.lang.String path, CSVSyntax csvConfig, DataHandle handle, ARXConfiguration config, long bytes)` Creates a new instance.

  - ### Uses of ARXConfiguration in org.deidentifier.arx.metric

    Methods in org.deidentifier.arx.metric with parameters of type ARXConfiguration
    Modifier and Type | Method and Description
    --- | ---
    `protected int` | Metric.`getNumRecords(ARXConfiguration config, org.deidentifier.arx.framework.data.Data input)` Returns the number of records
    `protected RowSet` | Metric.`getSubset(ARXConfiguration config)` Returns the subset
    `void` | Metric.`initialize(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] hierarchies, ARXConfiguration config)` Initializes the metric.
    `protected void` | MetricNMEntropy.`initializeInternal(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] hierarchies, ARXConfiguration config)`
    `protected void` | MetricAECS.`initializeInternal(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] hierarchies, ARXConfiguration config)`
    `protected void` | MetricDM.`initializeInternal(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] hierarchies, ARXConfiguration config)`
    `protected void` | MetricHeight.`initializeInternal(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] hierarchies, ARXConfiguration config)`
    `protected void` | MetricStatic.`initializeInternal(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] hierarchies, ARXConfiguration config)`
    `protected void` | MetricEntropy.`initializeInternal(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] ahierarchies, ARXConfiguration config)`
    `protected void` | MetricWeighted.`initializeInternal(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] hierarchies, ARXConfiguration config)`
    `protected void` | MetricDefault.`initializeInternal(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] hierarchies, ARXConfiguration config)`
    `protected abstract void` | Metric.`initializeInternal(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] hierarchies, ARXConfiguration config)` Implement this to initialize the metric.
    `protected void` | MetricNMPrecision.`initializeInternal(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] hierarchies, ARXConfiguration config)`
    `protected void` | MetricPrecision.`initializeInternal(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] hierarchies, ARXConfiguration config)`
    `protected void` | MetricDMStar.`initializeInternal(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] hierarchies, ARXConfiguration config)`
    `ElementData` | MetricNMEntropy.`render(ARXConfiguration config)`
    `ElementData` | MetricAECS.`render(ARXConfiguration config)`
    `ElementData` | MetricDM.`render(ARXConfiguration config)`
    `ElementData` | MetricHeight.`render(ARXConfiguration config)`
    `ElementData` | MetricStatic.`render(ARXConfiguration config)`
    `ElementData` | MetricEntropy.`render(ARXConfiguration config)`
    `abstract ElementData` | Metric.`render(ARXConfiguration config)` Renders the privacy model
    `ElementData` | MetricNMPrecision.`render(ARXConfiguration config)`
    `ElementData` | MetricPrecision.`render(ARXConfiguration config)`
    `ElementData` | MetricDMStar.`render(ARXConfiguration config)`

  - ### Uses of ARXConfiguration in org.deidentifier.arx.metric.v2

    Methods in org.deidentifier.arx.metric.v2 with parameters of type ARXConfiguration
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | MetricSDNMEntropyBasedInformationLoss.`initializeInternal(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] hierarchies, ARXConfiguration config)`
    `protected void` | AbstractMetricSingleDimensional.`initializeInternal(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] hierarchies, ARXConfiguration config)`
    `protected void` | MetricSDNMKLDivergence.`initializeInternal(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] hierarchies, ARXConfiguration config)`
    `protected void` | MetricMDNMLossPrecomputed.`initializeInternal(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] hierarchies, ARXConfiguration config)`
    `protected void` | MetricSDNMAmbiguity.`initializeInternal(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] hierarchies, ARXConfiguration config)`
    `protected void` | MetricMDNUEntropyPrecomputed.`initializeInternal(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] hierarchies, ARXConfiguration config)`
    `protected void` | MetricMDNMPrecision.`initializeInternal(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] hierarchies, ARXConfiguration config)`
    `protected void` | MetricMDNUNMEntropyPrecomputed.`initializeInternal(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] hierarchies, ARXConfiguration config)`
    `protected void` | MetricSDNMPublisherPayout.`initializeInternal(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] hierarchies, ARXConfiguration config)`
    `protected void` | AbstractMetricMultiDimensional.`initializeInternal(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] hierarchies, ARXConfiguration config)`
    `protected void` | MetricMDHeight.`initializeInternal(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] hierarchies, ARXConfiguration config)`
    `protected void` | AbstractMetricMultiDimensionalPotentiallyPrecomputed.`initializeInternal(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] ahierarchies, ARXConfiguration config)`
    `protected void` | MetricMDNUNMNormalizedEntropyPrecomputed.`initializeInternal(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] hierarchies, ARXConfiguration config)`
    `protected void` | MetricMDStatic.`initializeInternal(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] hierarchies, ARXConfiguration config)`
    `protected void` | MetricMDNMLoss.`initializeInternal(org.deidentifier.arx.framework.data.DataManager manager, DataDefinition definition, org.deidentifier.arx.framework.data.Data input, org.deidentifier.arx.framework.data.GeneralizationHierarchy[] hierarchies, ARXConfiguration config)`
    `ElementData` | MetricMDPrecision.`render(ARXConfiguration config)`
    `ElementData` | MetricSDNMEntropyBasedInformationLoss.`render(ARXConfiguration config)`
    `ElementData` | MetricMDNUNMNormalizedEntropyPotentiallyPrecomputed.`render(ARXConfiguration config)`
    `ElementData` | MetricSDNMKLDivergence.`render(ARXConfiguration config)`
    `ElementData` | MetricMDNUNMNormalizedEntropy.`render(ARXConfiguration config)`
    `ElementData` | MetricMDNMLossPrecomputed.`render(ARXConfiguration config)`
    `ElementData` | MetricSDNMAmbiguity.`render(ARXConfiguration config)`
    `ElementData` | MetricMDNUEntropyPrecomputed.`render(ARXConfiguration config)`
    `ElementData` | MetricMDNMPrecision.`render(ARXConfiguration config)`
    `ElementData` | MetricMDNUNMEntropy.`render(ARXConfiguration config)`
    `ElementData` | MetricSDAECS.`render(ARXConfiguration config)`
    `ElementData` | MetricMDNUNMEntropyPrecomputed.`render(ARXConfiguration config)`
    `ElementData` | MetricSDNMPublisherPayout.`render(ARXConfiguration config)`
    `ElementData` | MetricMDNUEntropy.`render(ARXConfiguration config)`
    `ElementData` | MetricMDHeight.`render(ARXConfiguration config)`
    `ElementData` | MetricSDNMDiscernability.`render(ARXConfiguration config)`
    `ElementData` | MetricSDDiscernability.`render(ARXConfiguration config)`
    `ElementData` | MetricMDNUNMNormalizedEntropyPrecomputed.`render(ARXConfiguration config)`
    `ElementData` | MetricMDStatic.`render(ARXConfiguration config)`
    `ElementData` | MetricMDNUEntropyPotentiallyPrecomputed.`render(ARXConfiguration config)`
    `ElementData` | MetricMDNMLossPotentiallyPrecomputed.`render(ARXConfiguration config)`
    `ElementData` | MetricMDNMLoss.`render(ARXConfiguration config)`
    `ElementData` | MetricMDNUNMEntropyPotentiallyPrecomputed.`render(ARXConfiguration config)`

  - ### Uses of ARXConfiguration in org.deidentifier.arx.risk

    Constructors in org.deidentifier.arx.risk with parameters of type ARXConfiguration
    Constructor and Description
    `RiskEstimateBuilder(ARXPopulationModel population, DataHandleInternal handle, RiskModelHistogram classes, ARXConfiguration arxconfig)` Creates a new instance
    `RiskEstimateBuilder(ARXPopulationModel population, DataHandleInternal handle, RiskModelHistogram classes, ARXSolverConfiguration solverconfig, ARXConfiguration arxconfig)` Creates a new instance
    `RiskEstimateBuilder(ARXPopulationModel population, DataHandleInternal handle, java.util.Set<java.lang.String> identifiers, ARXConfiguration arxconfig)` Creates a new instance
    `RiskEstimateBuilder(ARXPopulationModel population, DataHandleInternal handle, java.util.Set<java.lang.String> identifiers, ARXSolverConfiguration solverconfig, ARXConfiguration arxconfig)` Creates a new instance
    `RiskModelSampleRiskDistribution(RiskModelHistogram histogram, ARXConfiguration config, boolean anonymous)` Creates a new instance
    `RiskModelSampleRisks(RiskModelHistogram histogram, ARXConfiguration config, boolean anonymous)` Creates a new instance