public class Model
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Class and Description |
---|---|
static class |
Model.Perspective
The currently selected perspective
|
Constructor and Description |
---|
Model(java.lang.String name,
java.lang.String description,
java.util.Locale locale)
Creates a new instance.
|
Modifier and Type | Method and Description |
---|---|
void |
addAuditTrailEntry(ModelAuditTrailEntry entry)
Adds an entry to the audit trail
|
ARXAnonymizer |
createAnonymizer()
Creates an anonymizer for the current config.
|
void |
createClonedConfig()
Replaces the output config with a clone of the input config.
|
void |
createConfig()
Creates an ARXConfiguration.
|
ModelAnonymizationConfiguration |
getAnonymizationConfiguration()
Returns the current anonymization configuration
|
ARXAnonymizer |
getAnonymizer()
Returns the current anonymizer.
|
java.lang.String[] |
getAttributePair()
Returns the last two selected attributes.
|
java.util.List<ModelAuditTrailEntry> |
getAuditTrail()
Returns the audit trail
|
java.util.Map<java.lang.String,ModelBLikenessCriterion> |
getBLikenessModel()
Returns the b-Likeness privacy model.
|
java.lang.String |
getCharset()
Return charset.
|
ModelClassification |
getClassificationModel()
Returns the classification model
|
ModelClipboard |
getClipboard()
Returns the clipboard.
|
CSVSyntax |
getCSVSyntax()
Gets the csv config model.
|
java.util.Map<java.lang.String,ModelDDisclosurePrivacyCriterion> |
getDDisclosurePrivacyModel()
Returns the d-disclosure privacy model.
|
java.lang.String |
getDescription()
Returns the project description.
|
ModelDifferentialPrivacyCriterion |
getDifferentialPrivacyModel()
Returns the (e,d)-DP model.
|
ModelDPresenceCriterion |
getDPresenceModel()
Returns the d-presence model.
|
int[] |
getGroups()
Returns a list of indices of all equivalence classes.
|
java.lang.Integer |
getHeuristicSearchStepLimit() |
java.lang.Integer |
getHeuristicSearchThreshold() |
java.lang.Integer |
getHeuristicSearchTimeLimit() |
int |
getHistorySize()
Returns the according parameter.
|
int |
getInitialNodesInViewer()
Returns an upper bound on the number of nodes that will initially
be displayed in the lattice viewer.
|
long |
getInputBytes()
Returns the size in bytes of the input file.
|
ModelConfiguration |
getInputConfig()
Returns the input configuration.
|
DataDefinition |
getInputDefinition()
Returns the input definition.
|
ARXPopulationModel |
getInputPopulationModel()
Returns the input population model
|
ModelKAnonymityCriterion |
getKAnonymityModel()
Returns the k-anonymity model.
|
ModelKMapCriterion |
getKMapModel()
Returns the k-map model.
|
java.util.Map<java.lang.String,ModelLDiversityCriterion> |
getLDiversityModel()
Returns the l-diversity model.
|
java.util.Locale |
getLocale()
Returns the project locale.
|
ModelLocalRecoding |
getLocalRecodingModel()
Returns the model for local recoding
|
int |
getMaximalSizeForComplexOperations()
When a dataset has more records than this threshold,
visualization of statistics will be disabled.
|
int |
getMaxNodesInViewer()
Returns the maximal size of a sub-lattice that will be displayed
by the viewer.
|
MetricConfiguration |
getMetricConfiguration()
Returns the configuration of the metric.
|
MetricDescription |
getMetricDescription()
Returns a description of the metric.
|
java.lang.String |
getName()
Returns the name of this project.
|
ModelNodeFilter |
getNodeFilter()
Returns the current filter.
|
java.lang.String |
getOptimalNodeAsString()
Returns a string representation of the current optimum.
|
DataHandle |
getOutput() |
ModelConfiguration |
getOutputConfig()
Returns the output config.
|
DataDefinition |
getOutputDefinition()
Returns the output definition.
|
java.lang.String |
getOutputNodeAsString()
Returns a string representation of the currently applied transformation.
|
ARXPopulationModel |
getOutputPopulationModel()
Returns the output population model, if any.
|
ARXLattice.ARXNode |
getOutputTransformation()
Returns the currently applied transformation.
|
java.lang.String |
getPath()
Returns the path of the project.
|
Model.Perspective |
getPerspective() |
ARXProcessStatistics |
getProcessStatistics() |
java.lang.String |
getQuery()
Returns the current query.
|
ARXResult |
getResult()
Returns the current result.
|
java.util.Set<ModelRiskBasedCriterion> |
getRiskBasedModel()
Returns the risk-based model.
|
ModelRisk |
getRiskModel()
Returns the risk model
|
java.lang.String |
getSelectedAttribute()
Returns the currently selected attribute.
|
java.util.Set<java.lang.String> |
getSelectedClasses()
Returns the selected classes
|
java.lang.String[] |
getSelectedClassesAsArray()
Returns the selected classes, ordered by occurrence in the dataset
|
java.lang.String |
getSelectedClassValue()
Returns the currently selected class value.
|
java.util.Set<java.lang.String> |
getSelectedFeatures()
Returns the selected features
|
java.lang.String[] |
getSelectedFeaturesAsArray()
Returns the selected features, ordered by occurrence in the dataset
|
ARXLattice.ARXNode |
getSelectedNode()
Returns the selected transformation.
|
java.util.Set<java.lang.String> |
getSelectedQuasiIdentifiers()
Returns a set of quasi identifiers selected for risk analysis
|
char |
getSeparator()
Returns the separator.
|
double |
getSnapshotSizeDataset()
Returns the according parameter.
|
double |
getSnapshotSizeSnapshot()
Returns the according parameter.
|
double |
getSolutionSpaceSize()
Returns the size of the solution space for the current
input parameters
|
ModelProfitabilityCriterion |
getStackelbergModel()
Returns the configuration object for the stackelberg privacy model
|
java.lang.String |
getSubsetOrigin()
Returns the origin of the subset.
|
java.util.Map<java.lang.String,ModelTClosenessCriterion> |
getTClosenessModel()
Returns the t-closeness model.
|
long |
getTime()
Returns the execution time of the last anonymization process.
|
java.lang.Boolean |
getUseFunctionalHierarchies()
Returns whether functional hierarchies should be used
|
java.lang.Boolean |
getUseListwiseDeletion()
Returns whether list-wise deletion is used for summary statistics
|
ModelViewConfig |
getViewConfig()
Returns the view configuration.
|
boolean |
isDebugEnabled()
Returns whether debugging is enabled.
|
boolean |
isModified()
Returns whether this project is modified.
|
boolean |
isQuasiIdentifierSelected()
Returns whether a quasi-identifier is selected.
|
boolean |
isSensitiveAttributeSelected()
Returns whether a sensitive attribute is selected.
|
boolean |
isVisualizationEnabled()
Returns whether visualization is enabled.
|
void |
reset()
Resets the model.
|
void |
resetAttributePair()
Returns the last two selected attributes.
|
void |
resetCriteria()
Resets the configuration of the privacy criteria.
|
void |
setAnonymizer(ARXAnonymizer anonymizer)
Sets the anonymizer.
|
void |
setCharset(java.lang.String charset)
Sets the charset
|
void |
setDebugEnabled(boolean value)
Enables debugging.
|
void |
setDescription(java.lang.String description)
Sets the project description.
|
boolean |
setFeaturesAndClasses(DataDefinition definition)
Updates features and classes to reflect the definition provided
|
void |
setGroups(int[] groups)
Sets the indices of equivalence classes.
|
void |
setHeuristicSearchStepLimit(java.lang.Integer heuristicSearchStepLimit) |
void |
setHeuristicSearchThreshold(java.lang.Integer heuristicSearchThreshold) |
void |
setHeuristicSearchTimeLimit(java.lang.Integer heuristicSearchTimeLimit) |
void |
setHistorySize(int historySize)
Sets the according parameter.
|
void |
setInitialNodesInViewer(int val)
Sets the according parameter.
|
void |
setInputBytes(long inputBytes)
Sets the size of the input in bytes.
|
void |
setInputConfig(ModelConfiguration config)
Sets the input config.
|
void |
setLocale(java.util.Locale locale)
Sets the project locale.
|
void |
setMaximalSizeForComplexOperations(int numberOfRows)
Sets the according parameter.
|
void |
setMaxNodesInViewer(int maxNodesInViewer)
Sets the according parameter.
|
void |
setMetricDescription(MetricDescription description)
Sets the description of the metric.
|
void |
setModified()
Marks this project as modified.
|
void |
setName(java.lang.String name)
Sets the project name.
|
void |
setNodeFilter(ModelNodeFilter filter)
Sets a filter.
|
void |
setOutput(DataHandle output,
ARXLattice.ARXNode node)
Sets the current output.
|
void |
setOutput(java.io.InputStream stream)
Sets the current output, deserialized from a project
|
void |
setOutputConfig(ModelConfiguration config)
Sets the output config.
|
void |
setPath(java.lang.String path)
Sets the project path.
|
void |
setPerspective(Model.Perspective perspective) |
void |
setProcessStatistics(ARXProcessStatistics optimizationStatistics) |
void |
setQuery(java.lang.String query)
Sets the query.
|
void |
setResult(ARXResult result)
Sets the result.
|
void |
setSelectedAttribute(java.lang.String attribute)
Sets the selected attribute.
|
void |
setSelectedClasses(java.util.Set<java.lang.String> set)
Sets a set of selected attributes
|
void |
setSelectedClassValue(java.lang.String classValue)
Sets the selected class value.
|
void |
setSelectedFeatures(java.util.Set<java.lang.String> set)
Sets a set of selected attributes
|
void |
setSelectedNode(ARXLattice.ARXNode node)
Sets the selected node.
|
void |
setSelectedQuasiIdentifiers(java.util.Set<java.lang.String> set)
Sets a set of quasi identifiers selected for risk analysis
|
void |
setSnapshotSizeDataset(double snapshotSize) |
void |
setSnapshotSizeSnapshot(double snapshotSize)
Sets the according parameter.
|
void |
setSubsetManual()
Sets how the subset was defined.
|
void |
setSubsetOrigin(java.lang.String origin)
Sets how the subset was defined.
|
void |
setTime(long time)
Sets the execution time of the last anonymization process.
|
void |
setUnmodified()
Marks this model as unmodified.
|
void |
setUseFunctionalHierarchies(boolean useFunctionalHierarchies)
Sets whether functional hierarchies should be used during anonymization to estimate utility
|
void |
setUseListwiseDeletion(boolean useListwiseDeletion)
Sets whether list-wise deletion should be used for summary statistics
|
void |
setViewConfig(ModelViewConfig viewConfig)
Sets the view configuration.
|
void |
setVisualizationEnabled(boolean value)
Sets visualization as enabled/disabled.
|
public Model(java.lang.String name, java.lang.String description, java.util.Locale locale)
name
- description
- locale
- public void addAuditTrailEntry(ModelAuditTrailEntry entry)
entry
- public ARXAnonymizer createAnonymizer()
public void createClonedConfig()
public void createConfig()
public ModelAnonymizationConfiguration getAnonymizationConfiguration()
public ARXAnonymizer getAnonymizer()
public java.lang.String[] getAttributePair()
public java.util.List<ModelAuditTrailEntry> getAuditTrail()
public java.util.Map<java.lang.String,ModelBLikenessCriterion> getBLikenessModel()
public java.lang.String getCharset()
null
for projects with unknown charset, "UTF-8" else.public ModelClassification getClassificationModel()
public ModelClipboard getClipboard()
public CSVSyntax getCSVSyntax()
public java.util.Map<java.lang.String,ModelDDisclosurePrivacyCriterion> getDDisclosurePrivacyModel()
public java.lang.String getDescription()
public ModelDifferentialPrivacyCriterion getDifferentialPrivacyModel()
public ModelDPresenceCriterion getDPresenceModel()
public int[] getGroups()
public java.lang.Integer getHeuristicSearchStepLimit()
public java.lang.Integer getHeuristicSearchThreshold()
public java.lang.Integer getHeuristicSearchTimeLimit()
public int getHistorySize()
public int getInitialNodesInViewer()
public long getInputBytes()
public ModelConfiguration getInputConfig()
public DataDefinition getInputDefinition()
public ARXPopulationModel getInputPopulationModel()
public ModelKAnonymityCriterion getKAnonymityModel()
public ModelKMapCriterion getKMapModel()
public java.util.Map<java.lang.String,ModelLDiversityCriterion> getLDiversityModel()
public java.util.Locale getLocale()
public ModelLocalRecoding getLocalRecodingModel()
public int getMaximalSizeForComplexOperations()
public int getMaxNodesInViewer()
public MetricConfiguration getMetricConfiguration()
public MetricDescription getMetricDescription()
public java.lang.String getName()
public ModelNodeFilter getNodeFilter()
public java.lang.String getOptimalNodeAsString()
public DataHandle getOutput()
public ModelConfiguration getOutputConfig()
public DataDefinition getOutputDefinition()
public java.lang.String getOutputNodeAsString()
public ARXPopulationModel getOutputPopulationModel()
public ARXLattice.ARXNode getOutputTransformation()
public java.lang.String getPath()
public Model.Perspective getPerspective()
public ARXProcessStatistics getProcessStatistics()
public java.lang.String getQuery()
public ARXResult getResult()
public java.util.Set<ModelRiskBasedCriterion> getRiskBasedModel()
public ModelRisk getRiskModel()
public java.lang.String getSelectedAttribute()
public java.util.Set<java.lang.String> getSelectedClasses()
public java.lang.String[] getSelectedClassesAsArray()
public java.lang.String getSelectedClassValue()
public java.util.Set<java.lang.String> getSelectedFeatures()
public java.lang.String[] getSelectedFeaturesAsArray()
public ARXLattice.ARXNode getSelectedNode()
public java.util.Set<java.lang.String> getSelectedQuasiIdentifiers()
public char getSeparator()
public double getSnapshotSizeDataset()
public double getSnapshotSizeSnapshot()
public double getSolutionSpaceSize()
public ModelProfitabilityCriterion getStackelbergModel()
public java.lang.String getSubsetOrigin()
public java.util.Map<java.lang.String,ModelTClosenessCriterion> getTClosenessModel()
public long getTime()
public java.lang.Boolean getUseFunctionalHierarchies()
public java.lang.Boolean getUseListwiseDeletion()
public ModelViewConfig getViewConfig()
public boolean isDebugEnabled()
public boolean isModified()
public boolean isQuasiIdentifierSelected()
public boolean isSensitiveAttributeSelected()
public boolean isVisualizationEnabled()
public void reset()
public void resetAttributePair()
public void resetCriteria()
public void setAnonymizer(ARXAnonymizer anonymizer)
anonymizer
- public void setCharset(java.lang.String charset)
charset
- public void setDebugEnabled(boolean value)
value
- public void setDescription(java.lang.String description)
description
- public boolean setFeaturesAndClasses(DataDefinition definition)
definition
- public void setGroups(int[] groups)
groups
- public void setHeuristicSearchStepLimit(java.lang.Integer heuristicSearchStepLimit)
heuristicSearchStepLimit
- the heuristicSearchStepLimit to setpublic void setHeuristicSearchThreshold(java.lang.Integer heuristicSearchThreshold)
heuristicSearchThreshold
- the heuristicSearchThreshold to setpublic void setHeuristicSearchTimeLimit(java.lang.Integer heuristicSearchTimeLimit)
heuristicSearchTimeLimit
- the heuristicSearchTimeLimit to setpublic void setHistorySize(int historySize)
historySize
- public void setInitialNodesInViewer(int val)
val
- public void setInputBytes(long inputBytes)
inputBytes
- public void setInputConfig(ModelConfiguration config)
config
- public void setLocale(java.util.Locale locale)
locale
- Null for default localepublic void setMaximalSizeForComplexOperations(int numberOfRows)
numberOfRows
- public void setMaxNodesInViewer(int maxNodesInViewer)
maxNodesInViewer
- public void setMetricDescription(MetricDescription description)
description
- public void setModified()
public void setName(java.lang.String name)
name
- public void setNodeFilter(ModelNodeFilter filter)
filter
- public void setOutput(DataHandle output, ARXLattice.ARXNode node)
output
- node
- public void setOutput(java.io.InputStream stream) throws java.lang.ClassNotFoundException, java.io.IOException
stream
- node
- java.io.IOException
java.lang.ClassNotFoundException
public void setOutputConfig(ModelConfiguration config)
config
- public void setPath(java.lang.String path)
path
- public void setPerspective(Model.Perspective perspective)
perspective
- the perspective to setpublic void setProcessStatistics(ARXProcessStatistics optimizationStatistics)
optimizationStatistics
- the optimizationStatistics to setpublic void setQuery(java.lang.String query)
query
- public void setResult(ARXResult result)
result
- public void setSelectedAttribute(java.lang.String attribute)
attribute
- public void setSelectedClasses(java.util.Set<java.lang.String> set)
set
- public void setSelectedClassValue(java.lang.String classValue)
classValue
- public void setSelectedFeatures(java.util.Set<java.lang.String> set)
set
- public void setSelectedNode(ARXLattice.ARXNode node)
node
- public void setSelectedQuasiIdentifiers(java.util.Set<java.lang.String> set)
set
- public void setSnapshotSizeDataset(double snapshotSize)
snapshotSize
- public void setSnapshotSizeSnapshot(double snapshotSize)
snapshotSize
- public void setSubsetManual()
public void setSubsetOrigin(java.lang.String origin)
origin
- public void setTime(long time)
time
- public void setUnmodified()
public void setUseFunctionalHierarchies(boolean useFunctionalHierarchies)
useFunctionalHierarchies
- public void setUseListwiseDeletion(boolean useListwiseDeletion)
useListwiseDeletion
- public void setViewConfig(ModelViewConfig viewConfig)
viewConfig
- public void setVisualizationEnabled(boolean value)
value
-