org.apache.solr.client.solrj.io

Class Tuple

java.lang.Object

org.apache.solr.client.solrj.io.Tuple

All Implemented Interfaces:

Cloneable, MapSerializable, MapWriter, NavigableObject

Direct Known Subclasses:

DbscanEvaluator.ClusterTuple, KmeansEvaluator.ClusterTuple, KnnRegressionEvaluator.KnnRegressionTuple, LoessEvaluator.LoessRegressionTuple, OLSRegressionEvaluator.MultipleRegressionTuple, RegressionEvaluator.RegressionTuple

public class Tuple
extends Object
implements Cloneable, MapWriter

A simple abstraction of a record containing key/value pairs. Convenience methods are provided for returning single and multiValue String, Long and Double values. Note that ints and floats are treated as longs and doubles respectively.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.solr.common.MapWriter

MapWriter.EntryWriter

Field Summary

Fields

Modifier and Type	Field and Description
boolean	EOF When EOF field is true the Tuple marks the end of the stream.
boolean	EXCEPTION When EXCEPTION field is true the Tuple marks an exception in the stream and the corresponding "EXCEPTION" field contains a related message.
Map<String,String>	fieldLabels Deprecated. use getFieldLabels() instead of this public field.
List<String>	fieldNames Deprecated. use getFieldNames() instead of this public field.
Map<Object,Object>	fields Deprecated. use getFields() instead of this public field.

Constructor Summary

Constructors

Constructor and Description
Tuple()
Tuple(Map<?,?> fields) A copy constructor.
Tuple(Object... fields) Constructor that accepts an even number of arguments as key / value pairs.

Method Summary

Modifier and Type	Method and Description
Tuple	clone()
static Tuple	EOF() Create a new empty tuple marked as EOF.
static Tuple	EXCEPTION(String msg, boolean eof) Create a new empty tuple marked as EXCEPTION, and optionally EOF.
Object	get(Object key)
Boolean	getBool(Object key)
List<Boolean>	getBools(Object key)
Date	getDate(Object key)
List<Date>	getDates(Object key)
Double	getDouble(Object key)
List<Double>	getDoubles(Object key)
String	getException()
Map<String,String>	getFieldLabels() This represents the mapping of external field labels to the tuple's internal field names if they are different from field names.
List<String>	getFieldNames() A list of field names to serialize.
Map<Object,Object>	getFields() Return all tuple fields and their values.
Long	getLong(Object key)
List<Long>	getLongs(Object key)
Map	getMap() Deprecated. use getFields() instead.
List<Map>	getMaps(Object key)
Map<String,Map>	getMetrics()
String	getString(Object key)
List<String>	getStrings(Object key)
void	merge(Tuple other)
void	put(Object key, Object value)
void	remove(Object key)
void	setFieldLabels(Map<String,String> fieldLabels)
void	setFieldNames(List<String> fieldNames)
void	setMaps(Object key, List<Map> maps)
void	setMetrics(Map<String,Map> metrics)
void	writeMap(MapWriter.EntryWriter ew)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.solr.common.MapWriter

jsonStr, toMap

Methods inherited from interface org.apache.solr.common.NavigableObject

_forEachEntry, _forEachEntry, _forEachEntry, _get, _get, _getStr, _getStr

Field Detail

EOF

public boolean EOF

When EOF field is true the Tuple marks the end of the stream. The EOF Tuple will not contain a record from the stream, but it may contain metrics/aggregates gathered by underlying streams.

EXCEPTION

public boolean EXCEPTION

When EXCEPTION field is true the Tuple marks an exception in the stream and the corresponding "EXCEPTION" field contains a related message.

fields

@Deprecated
public Map<Object,Object> fields

Deprecated. use getFields() instead of this public field.

Tuple fields.

fieldNames

@Deprecated
public List<String> fieldNames

Deprecated. use getFieldNames() instead of this public field.

External serializable field names.

fieldLabels

@Deprecated
public Map<String,String> fieldLabels

Deprecated. use getFieldLabels() instead of this public field.

Mapping of external field names to internal tuple field names.

Constructor Detail

Tuple

public Tuple()

Tuple

public Tuple(Map<?,?> fields)

A copy constructor.

Parameters:

fields - map containing keys and values to be copied to this tuple

Tuple

public Tuple(Object... fields)

Constructor that accepts an even number of arguments as key / value pairs.

Parameters:

fields - a list of key / value pairs, with keys at odd and values at even positions.

Method Detail

get

public Object get(Object key)

put

public void put(Object key,
                Object value)

remove

public void remove(Object key)

getString

public String getString(Object key)

getException

public String getException()

getLong

public Long getLong(Object key)

getBool

public Boolean getBool(Object key)

getBools

public List<Boolean> getBools(Object key)

getDate

public Date getDate(Object key)

getDates

public List<Date> getDates(Object key)

getDouble

public Double getDouble(Object key)

getStrings

public List<String> getStrings(Object key)

getLongs

public List<Long> getLongs(Object key)

getDoubles

public List<Double> getDoubles(Object key)

getFields

public Map<Object,Object> getFields()

Return all tuple fields and their values.

getMap

@Deprecated
public Map getMap()

Deprecated. use getFields() instead.

Return all tuple fields.

getFieldLabels

public Map<String,String> getFieldLabels()

This represents the mapping of external field labels to the tuple's internal field names if they are different from field names.

Returns:

field labels or null

setFieldLabels

public void setFieldLabels(Map<String,String> fieldLabels)

getFieldNames

public List<String> getFieldNames()

A list of field names to serialize. This list (together with the mapping in getFieldLabels() determines what tuple values are serialized and their external (serialized) names.

Returns:

list of external field names or null

setFieldNames

public void setFieldNames(List<String> fieldNames)

getMaps

public List<Map> getMaps(Object key)

setMaps

public void setMaps(Object key,
                    List<Map> maps)

getMetrics

public Map<String,Map> getMetrics()

setMetrics

public void setMetrics(Map<String,Map> metrics)

clone

public Tuple clone()

Overrides:

clone in class Object

merge

public void merge(Tuple other)

writeMap

public void writeMap(MapWriter.EntryWriter ew)
              throws IOException

Specified by:

writeMap in interface MapWriter

Throws:

IOException

EOF

public static Tuple EOF()

Create a new empty tuple marked as EOF.

EXCEPTION

public static Tuple EXCEPTION(String msg,
                              boolean eof)

Create a new empty tuple marked as EXCEPTION, and optionally EOF.

Parameters:

msg - exception message

eof - if true the tuple will be marked as EOF