de.lmu.ifi.dbs.elki.datasource.filter.selection

Class ByLabelFilter

java.lang.Object

de.lmu.ifi.dbs.elki.datasource.filter.AbstractStreamFilter

de.lmu.ifi.dbs.elki.datasource.filter.selection.ByLabelFilter

All Implemented Interfaces:

BundleStreamSource, ObjectFilter, StreamFilter

@Alias(value={"de.lmu.ifi.dbs.elki.datasource.filter.ByLabelFilter","de.lmu.ifi.dbs.elki.datasource.filter.FilterByLabelFilter"})
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 and Description
static class	ByLabelFilter.Parameterizer Parameterization class.

Nested classes/interfaces inherited from interface de.lmu.ifi.dbs.elki.datasource.bundle.BundleStreamSource

BundleStreamSource.Event

Field Summary

Fields

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

Fields inherited from class de.lmu.ifi.dbs.elki.datasource.filter.AbstractStreamFilter

source

Constructor Summary

Constructors

Constructor and Description
ByLabelFilter(Pattern pattern, boolean inverted) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
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 de.lmu.ifi.dbs.elki.datasource.filter.AbstractStreamFilter

asMultipleObjectsBundle, assignDBID, filter, hasDBIDs, init

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

private static final Logging LOG

Class logger

matcher

private final Matcher matcher

The filter pattern matcher

inverted

private final boolean inverted

Inversion flag

lblcol

private int lblcol

Label column

Constructor Detail

ByLabelFilter

public ByLabelFilter(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 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