Package weka.filters.unsupervised.attribute

Class Obfuscate

java.lang.Object

weka.filters.Filter

weka.filters.unsupervised.attribute.Obfuscate

All Implemented Interfaces:

Serializable, CapabilitiesHandler, CapabilitiesIgnorer, CommandlineRunnable, OptionHandler, RevisionHandler, WeightedAttributesHandler, WeightedInstancesHandler, StreamableFilter, UnsupervisedFilter

public class Obfuscate
extends Filter
implements UnsupervisedFilter, StreamableFilter, WeightedAttributesHandler, WeightedInstancesHandler

A simple instance filter that renames the relation, all attribute names and all nominal attribute values. For exchanging sensitive datasets. Leaves string and relational attributes untouched.

Version:

$Revision$

Author:

Len Trigg (len@reeltwo.com)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Obfuscate()

Method Summary

Modifier and Type	Method	Description
Capabilities	getCapabilities()	Returns the Capabilities of this filter.
String	getRevision()	Returns the revision string.
String	globalInfo()	Returns a string describing this filter
boolean	input(Instance instance)	Input an instance for filtering.
static void	main(String[] argv)	Main method for testing this class.
boolean	setInputFormat(Instances instanceInfo)	Sets the format of the input instances.

Methods inherited from class weka.filters.Filter

batchFilterFile, batchFinished, debugTipText, doNotCheckCapabilitiesTipText, filterFile, getCapabilities, getCopyOfInputFormat, getDebug, getDoNotCheckCapabilities, getOptions, getOutputFormat, isFirstBatchDone, isNewBatch, isOutputFormatDefined, listOptions, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputPeek, postExecution, preExecution, run, runFilter, setDebug, setDoNotCheckCapabilities, setOptions, toString, useFilter, wekaStaticWrapper

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Obfuscate

public Obfuscate()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing this filter

Returns:

a description of the filter suitable for displaying in the explorer/experimenter gui

getCapabilities

public Capabilities getCapabilities()

Returns the Capabilities of this filter.

Specified by:

getCapabilities in interface CapabilitiesHandler

Overrides:

getCapabilities in class Filter

Returns:

the capabilities of this object

See Also:

Capabilities

setInputFormat

public boolean setInputFormat(Instances instanceInfo)
                       throws Exception

Sets the format of the input instances.

Overrides:

setInputFormat in class Filter

Parameters:

instanceInfo - an Instances object containing the input instance structure (any instances contained in the object are ignored - only the structure is required).

Returns:

true if the outputFormat may be collected immediately

Throws:

Exception - if

input

public boolean input(Instance instance)
              throws Exception

Input an instance for filtering. Ordinarily the instance is processed and made available for output immediately. Some filters require all instances be read before producing output.

Overrides:

input in class Filter

Parameters:

instance - the input instance

Returns:

true if the filtered instance may now be collected with output().

Throws:

IllegalStateException - if no input format has been set.

NullPointerException - if the input format has not been defined.

Exception - if the input instance was not of the correct format or if there was a problem with the filtering.

getRevision

public String getRevision()

Returns the revision string.

Specified by:

getRevision in interface RevisionHandler

Overrides:

getRevision in class Filter

Returns:

the revision

main

public static void main(String[] argv)

Main method for testing this class.

Parameters:

argv - should contain arguments to the filter: use -h for help