com.exalead.searchapi.xmlv10.client

Interface Meta

All Known Implementing Classes:

MetaImpl, MetaImpl

public interface Meta

Holds a metadata item which can multivalued and typed

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Meta.MetaType

Method Summary

Modifier and Type	Method and Description
double[]	getDoubleValues()
long[]	getLongValues()
java.lang.String	getName() Get the name of the meta.
java.lang.String	getStringValue() Get the first value of the meta as a string, or null if there is no value.
java.util.List<java.lang.String>	getStringValues() Get all values of the meta.
Meta.MetaType	getType() The type defines which of the getXXValue is relevant.
MetaValue	getValue() Get the first value of the meta.
java.util.List<MetaValue>	getValues() Get all values of the meta.

Method Detail

getName

java.lang.String getName()

Get the name of the meta.

getType

Meta.MetaType getType()

The type defines which of the getXXValue is relevant. It is always possible to call getStringValues to retrieve all values of the meta as strings, and getTextValues to retrieve all values of the meta as highlightable texts. To retrieve a meta of type TEXT, use getValues(), then getTextValue() on each MetaValue element.

getValues

java.util.List<MetaValue> getValues()

Get all values of the meta.

Returns:

the list of the values

getValue

MetaValue getValue()

Get the first value of the meta.

Returns:

the first value of the meta, or null if there no value.

getStringValue

java.lang.String getStringValue()

Get the first value of the meta as a string, or null if there is no value.

getStringValues

java.util.List<java.lang.String> getStringValues()

Get all values of the meta.

Returns:

All values of the meta, as string

getLongValues

long[] getLongValues()
              throws java.lang.IllegalArgumentException

Returns:

All values of the meta, as long

Throws:

java.lang.IllegalArgumentException - if the meta is not of long type.

getDoubleValues

double[] getDoubleValues()

Returns:

All values of the meta, as doubles

Throws:

java.lang.IllegalArgumentException - if the meta is not of double type.