ExternalIDFilter (ELKI: Environment for DeveLoping KDD-Applications Supported by Index-Structures)

java.lang.Object
- elki.datasource.filter.typeconversions.ExternalIDFilter

All Implemented Interfaces:

ObjectFilter
```
public class ExternalIDFilter
extends java.lang.Object
implements ObjectFilter
```
Class that turns a label column into an external ID column.

Since:

0.4.0

Author:

Erich Schubert

- Nested Class Summary
  
  Nested Classes
  Modifier and Type Class Description
  
  static class ExternalIDFilter.Par
  Parameterization class.
- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  private int externalIdIndex
  The index of the label to be used as external Id.
- Constructor Summary
  
  Constructors
  Constructor Description
  
  ExternalIDFilter(int externalIdIndex)
  Constructor.
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  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
  - externalIdIndex
```
private final int externalIdIndex
```
    The index of the label to be used as external Id.
- 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