de.lmu.ifi.dbs.elki.datasource.parser

Class NumberVectorLabelParser<V extends NumberVector<?>>

java.lang.Object

de.lmu.ifi.dbs.elki.datasource.parser.AbstractParser

de.lmu.ifi.dbs.elki.datasource.parser.AbstractStreamingParser

de.lmu.ifi.dbs.elki.datasource.parser.NumberVectorLabelParser<V>

Type Parameters:

V - the type of NumberVector used

All Implemented Interfaces:

BundleStreamSource, Parser, StreamingParser, InspectionUtilFrequentlyScanned, Parameterizable

Direct Known Subclasses:

DoubleVectorLabelParser, FloatVectorLabelParser, SparseNumberVectorLabelParser, TermFrequencyParser

public class NumberVectorLabelParser<V extends NumberVector<?>>
extends AbstractStreamingParser

Provides a parser for parsing one point per line, attributes separated by whitespace.

Several labels may be given per point. A label must not be parseable as double. Lines starting with "#" will be ignored.

An index can be specified to identify an entry to be treated as class label. This index counts all entries (numeric and labels as well) starting with 0.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NumberVectorLabelParser.Parameterizer<V extends NumberVector<?>> 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
protected List<String>	columnnames Column names.
protected LabelList	curlbl Current labels.
protected V	curvec Current vector.
protected int	dimensionality Dimensionality reported.
static int	DIMENSIONALITY_UNKNOWN Constant used for unknown dimensionality (e.g. empty files)
static int	DIMENSIONALITY_VARIABLE Constant used for records of variable dimensionality (e.g. time series)
protected NumberVector.Factory<V,?>	factory Vector factory class.
static OptionID	LABEL_INDICES_ID A comma separated list of the indices of labels (may be numeric), counting whitespace separated entries in a line starting with 0.
protected BitSet	labelcolumns Bitset to indicate which columns are not numeric.
protected BitSet	labelIndices Keeps the indices of the attributes to be treated as a string label.
protected int	lineNumber Current line number.
private static Logging	LOG Logging class.
protected BundleMeta	meta Metadata.
(package private) BundleStreamSource.Event	nextevent Event to report next.
private BufferedReader	reader Buffer reader.
static OptionID	VECTOR_TYPE_ID Parameter to specify the type of vectors to produce.

Fields inherited from class de.lmu.ifi.dbs.elki.datasource.parser.AbstractParser

ATTRIBUTE_CONCATENATION, COLUMN_SEPARATOR_ID, COMMENT, DEFAULT_SEPARATOR, NUMBER_PATTERN, QUOTE_CHAR, QUOTE_ID, quoteChar

Constructor Summary

Constructors

Constructor and Description
NumberVectorLabelParser(NumberVector.Factory<V,?> factory) Constructor with defaults.
NumberVectorLabelParser(Pattern colSep, char quoteChar, BitSet labelIndices, NumberVector.Factory<V,?> factory) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	buildMeta() Update the meta element.
protected <A> V	createDBObject(A attributes, NumberArrayAdapter<?,A> adapter) Creates a database object of type V.
Object	data(int rnum) Access a particular object and representation.
protected Logging	getLogger() Get the logger for this class.
BundleMeta	getMeta() Get the current meta data.
(package private) SimpleTypeInformation<V>	getTypeInformation(int dimensionality) Get a prototype object for the given dimensionality.
void	initStream(InputStream in) Init the streaming parser for the given input stream.
BundleStreamSource.Event	nextEvent() Get the next event
protected void	parseLineInternal(String line) Internal method for parsing a single line.

Methods inherited from class de.lmu.ifi.dbs.elki.datasource.parser.AbstractStreamingParser

parse

Methods inherited from class de.lmu.ifi.dbs.elki.datasource.parser.AbstractParser

tokenize, 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

Logging class.

LABEL_INDICES_ID

public static final OptionID LABEL_INDICES_ID

A comma separated list of the indices of labels (may be numeric), counting whitespace separated entries in a line starting with 0. The corresponding entries will be treated as a label.

Key: -parser.labelIndices

VECTOR_TYPE_ID

public static final OptionID VECTOR_TYPE_ID

Parameter to specify the type of vectors to produce.

Key: -parser.vector-type
Default: DoubleVector

DIMENSIONALITY_UNKNOWN

public static final int DIMENSIONALITY_UNKNOWN

Constant used for unknown dimensionality (e.g. empty files)

See Also:

Constant Field Values

DIMENSIONALITY_VARIABLE

public static final int DIMENSIONALITY_VARIABLE

Constant used for records of variable dimensionality (e.g. time series)

See Also:

Constant Field Values

labelIndices

protected BitSet labelIndices

Keeps the indices of the attributes to be treated as a string label.

factory

protected NumberVector.Factory<V extends NumberVector<?>,?> factory

Vector factory class.

reader

private BufferedReader reader

Buffer reader.

lineNumber

protected int lineNumber

Current line number.

dimensionality

protected int dimensionality

Dimensionality reported.

meta

protected BundleMeta meta

Metadata.

columnnames

protected List<String> columnnames

Column names.

labelcolumns

protected BitSet labelcolumns

Bitset to indicate which columns are not numeric.

curvec

protected V extends NumberVector<?> curvec

Current vector.

curlbl

protected LabelList curlbl

Current labels.

nextevent

BundleStreamSource.Event nextevent

Event to report next.

Constructor Detail

NumberVectorLabelParser

public NumberVectorLabelParser(NumberVector.Factory<V,?> factory)

Constructor with defaults.

Parameters:

factory - Vector factory

NumberVectorLabelParser

public NumberVectorLabelParser(Pattern colSep,
                       char quoteChar,
                       BitSet labelIndices,
                       NumberVector.Factory<V,?> factory)

Constructor.

Parameters:

colSep - Column separator

quoteChar - Quote character

labelIndices - Column indexes that are numeric.

factory - Vector factory

Method Detail

initStream

public void initStream(InputStream in)

Description copied from interface: StreamingParser

Init the streaming parser for the given input stream.

Parameters:

in - the stream to parse objects from

getMeta

public BundleMeta getMeta()

Description copied from interface: BundleStreamSource

Get the current meta data.

Returns:

Metadata

nextEvent

public BundleStreamSource.Event nextEvent()

Description copied from interface: BundleStreamSource

Get the next event

Returns:

Event type

buildMeta

protected void buildMeta()

Update the meta element.

data

public Object data(int rnum)

Description copied from interface: BundleStreamSource

Access a particular object and representation.

Parameters:

rnum - Representation number

Returns:

Contained data

parseLineInternal

protected void parseLineInternal(String line)

Internal method for parsing a single line. Used by both line based parsing as well as block parsing. This saves the building of meta data for each line.

Parameters:

line - Line to process

createDBObject

protected <A> V createDBObject(A attributes,
                   NumberArrayAdapter<?,A> adapter)

Creates a database object of type V.

Type Parameters:

A - attribute type

Parameters:

attributes - the attributes of the vector to create.

adapter - Array adapter

Returns:

a RalVector of type V containing the given attribute values

getTypeInformation

SimpleTypeInformation<V> getTypeInformation(int dimensionality)

Get a prototype object for the given dimensionality.

Parameters:

dimensionality - Dimensionality

Returns:

Prototype object

getLogger

protected Logging getLogger()

Description copied from class: AbstractParser

Get the logger for this class.

Specified by:

getLogger in class AbstractParser

Returns:

Logger.