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

java.lang.Object
- elki.datasource.filter.AbstractStreamFilter
- - elki.datasource.filter.selection.ByLabelFilter

All Implemented Interfaces:

BundleStreamSource, ObjectFilter, StreamFilter
```
public class ByLabelFilter
extends AbstractStreamFilter
```
A filter to select data set by their label.

Since:

0.4.0

Author:

Erich Schubert

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ByLabelFilter.Par
Parameterization class.
- Nested classes/interfaces inherited from interface elki.datasource.bundle.BundleStreamSource
  BundleStreamSource.Event

Field Summary

Fields
Modifier and Type	Field	Description
`private boolean`	`inverted`	Inversion flag
`private int`	`lblcol`	Label column
`private static Logging`	`LOG`	Class logger
`private java.util.regex.Matcher`	`matcher`	The filter pattern matcher

Fields inherited from class elki.datasource.filter.AbstractStreamFilter
source

Constructor Summary

Constructors
Constructor Description

ByLabelFilter(java.util.regex.Pattern pattern, boolean inverted)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.Object`	`data(int rnum)`	Access a particular object and representation.
`BundleMeta`	`getMeta()`	Get the current meta data.
`BundleStreamSource.Event`	`nextEvent()`	Get the next event

Methods inherited from class elki.datasource.filter.AbstractStreamFilter
asMultipleObjectsBundle, assignDBID, filter, hasDBIDs, init, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - LOG
```
private static final Logging LOG
```
    Class logger
  - matcher
```
private final java.util.regex.Matcher matcher
```
    The filter pattern matcher
  - inverted
```
private final boolean inverted
```
    Inversion flag
  - lblcol
```
private int lblcol
```
    Label column
- Constructor Detail
  - ByLabelFilter
```
public ByLabelFilter(java.util.regex.Pattern pattern,
                     boolean inverted)
```
    Constructor.
    
    Parameters:
    
    pattern - Filter pattern
    
    inverted - Inversion flag
- Method Detail
  - getMeta
```
public BundleMeta getMeta()
```
    Description copied from interface: BundleStreamSource
    
    Get the current meta data.
    
    Returns:
    
    Metadata
  - data
```
public java.lang.Object data(int rnum)
```
    Description copied from interface: BundleStreamSource
    
    Access a particular object and representation.
    
    Parameters:
    
    rnum - Representation number
    
    Returns:
    
    Contained data
  - nextEvent
```
public BundleStreamSource.Event nextEvent()
```
    Description copied from interface: BundleStreamSource
    
    Get the next event
    
    Returns:
    
    Event type