de.lmu.ifi.dbs.elki.datasource.filter
Class ExternalIDFilter

java.lang.Object
  extended by de.lmu.ifi.dbs.elki.datasource.filter.ExternalIDFilter
All Implemented Interfaces:
ObjectFilter

public class ExternalIDFilter
extends Object
implements ObjectFilter

Class that turns a label column into an external ID column.


Nested Class Summary
static class ExternalIDFilter.Parameterizer
          Parameterization class.
 
Field Summary
static OptionID EXTERNALID_INDEX_ID
          Optional parameter that specifies the index of the label to be used as external Id, must be an integer equal to or greater than 0.
private  int externalIdIndex
          The index of the label to be used as external Id, null if no external id index is specified.
 
Constructor Summary
ExternalIDFilter(int externalIdIndex)
          Constructor.
 
Method Summary
 MultipleObjectsBundle filter(MultipleObjectsBundle objects)
          Filter a set of object packages.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EXTERNALID_INDEX_ID

public static final OptionID EXTERNALID_INDEX_ID
Optional parameter that specifies the index of the label to be used as external Id, must be an integer equal to or greater than 0.

Key: -dbc.externalIdIndex


externalIdIndex

private final int externalIdIndex
The index of the label to be used as external Id, null if no external id index is specified.

Constructor Detail

ExternalIDFilter

public ExternalIDFilter(int externalIdIndex)
Constructor.

Parameters:
externalIdIndex -
Method Detail

filter

public MultipleObjectsBundle filter(MultipleObjectsBundle objects)
Description copied from interface: ObjectFilter
Filter a set of object packages.

Specified by:
filter in interface ObjectFilter
Parameters:
objects - Object to filter
Returns:
Filtered objects

Release 0.4.0 (2011-09-20_1324)