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

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

- Packages that use DataDefinition
  Package | Description
  --- | ---
  org.deidentifier.arx | This package provides the public API for the ARX anonymization framework.
  org.deidentifier.arx.certificate |
  org.deidentifier.arx.gui.model |
  org.deidentifier.arx.gui.view.impl.common |
  org.deidentifier.arx.gui.view.impl.common.async |
  org.deidentifier.arx.gui.worker |
  org.deidentifier.arx.metric | This package implements several metrics for information loss.
  org.deidentifier.arx.metric.v2 |

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

    Fields in org.deidentifier.arx declared as DataDefinition
    Modifier and Type | Field and Description
    --- | ---
    `protected DataDefinition` | DataHandle.`definition` The data definition.

    Methods in org.deidentifier.arx that return DataDefinition
    Modifier and Type | Method and Description
    --- | ---
    `DataDefinition` | DataDefinition.`clone()`
    `DataDefinition` | DataHandle.`getDefinition()` Returns the data definition.
    `DataDefinition` | DataHandleInternal.`getDefinition()` Method
    `DataDefinition` | Data.`getDefinition()` Returns the data definition.

    Methods in org.deidentifier.arx with parameters of type DataDefinition
    Modifier and Type | Method and Description
    --- | ---
    `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 .
    `int` | DataGeneralizationScheme.`getGeneralizationLevel(java.lang.String attribute, DataDefinition definition)` Returns a generalization level as defined by this class
    `void` | DataDefinition.`read(DataDefinition other)` Reads all settings from the given definition
    `protected void` | DataHandleInput.`setDefinition(DataDefinition definition)` Overrides the handles data definition.

    Constructors in org.deidentifier.arx with parameters of type DataDefinition
    Constructor and Description
    `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 DataDefinition in org.deidentifier.arx.certificate

    Methods in org.deidentifier.arx.certificate with parameters of type DataDefinition
    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 DataDefinition in org.deidentifier.arx.gui.model

    Methods in org.deidentifier.arx.gui.model that return DataDefinition
    Modifier and Type | Method and Description
    --- | ---
    `DataDefinition` | Model.`getInputDefinition()` Returns the input definition.
    `DataDefinition` | Model.`getOutputDefinition()` Returns the output definition.

  - ### Uses of DataDefinition in org.deidentifier.arx.gui.view.impl.common

    Methods in org.deidentifier.arx.gui.view.impl.common that return DataDefinition
    Modifier and Type | Method and Description
    --- | ---
    `protected DataDefinition` | ViewDataInput.`getDefinition()`
    `protected abstract DataDefinition` | ViewData.`getDefinition()` Returns the data definition.
    `protected DataDefinition` | ViewDataOutput.`getDefinition()`

  - ### Uses of DataDefinition in org.deidentifier.arx.gui.view.impl.common.async

    Fields in org.deidentifier.arx.gui.view.impl.common.async declared as DataDefinition
    Modifier and Type | Field and Description
    --- | ---
    `DataDefinition` | AnalysisData.`definition` The according definition.

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

    Constructors in org.deidentifier.arx.gui.worker with parameters of type DataDefinition
    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.

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

    Methods in org.deidentifier.arx.metric with parameters of type DataDefinition
    Modifier and Type | Method and Description
    --- | ---
    `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)`

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

    Methods in org.deidentifier.arx.metric.v2 with parameters of type DataDefinition
    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)`