com.yahoo.bullet.result

Class Meta

java.lang.Object

com.yahoo.bullet.result.Meta

public class Meta
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Meta.Concept

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERROR_KEY
static List<Meta.Concept>	KNOWN_CONCEPTS

Constructor Summary

Constructors

Constructor and Description
Meta()

Method Summary

Modifier and Type	Method and Description
Meta	add(String key, Object information) Add a piece of meta information.
Meta	addErrors(List<BulletError> errors) Add errors to the Meta.
static void	addIfNonNull(Map<String,Object> meta, Map<String,String> names, Meta.Concept concept, Supplier<Object> supplier) Utility function to add a concept with a configured name to a map representing metadata if both the name and and a value for the name produced by a given Supplier are not null.
Map<String,Object>	asMap() Returns a backing view of the meta information as a Map.
static void	consumeRegisteredConcept(Meta.Concept concept, Map<String,String> names, Consumer<String> action) Utility function to apply a method for a given Meta.Concept name if provided in the given Map of names.
Meta	merge(Meta meta) Merge another Meta into this Meta.
static Meta	of(BulletError... errors) Static construction of Meta with some errors.
static Meta	of(List<BulletError> errors) Static construction of Meta with some errors.

Methods inherited from class java.lang.Object

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

Field Detail

KNOWN_CONCEPTS

public static final List<Meta.Concept> KNOWN_CONCEPTS

ERROR_KEY

public static final String ERROR_KEY

See Also:

Constant Field Values

Constructor Detail

Meta

public Meta()

Method Detail

asMap

public Map<String,Object> asMap()

Returns a backing view of the meta information as a Map.

Returns:

A Map of keys to objects that denote the meta information.

add

public Meta add(String key,
                Object information)

Add a piece of meta information.

Parameters:

key - The name of the meta tag

information - An object that represents the information.

Returns:

This object for chaining.

addErrors

public Meta addErrors(List<BulletError> errors)

Add errors to the Meta.

Parameters:

errors - BulletError objects to add.

Returns:

This object for chaining.

of

public static Meta of(BulletError... errors)

Static construction of Meta with some errors.

Parameters:

errors - A non-null List of BulletError objects.

Returns:

The Meta object with the errors.

of

public static Meta of(List<BulletError> errors)

Static construction of Meta with some errors.

Parameters:

errors - A non-null list of BulletError objects.

Returns:

The Meta object with the errors.

merge

public Meta merge(Meta meta)

Merge another Meta into this Meta.

Parameters:

meta - A Meta to merge.

Returns:

This Object after the merge.

addIfNonNull

public static void addIfNonNull(Map<String,Object> meta,
                                Map<String,String> names,
                                Meta.Concept concept,
                                Supplier<Object> supplier)

Utility function to add a concept with a configured name to a map representing metadata if both the name and and a value for the name produced by a given Supplier are not null.

Parameters:

meta - The non-null Map representing the metadata.

names - The non-null Map of configured Meta.Concept names to key names to use.

concept - The concept to add

supplier - A Supplier that can produce a value to add to the metadata for the concept. If the supplier produces null, it is not added.

consumeRegisteredConcept

public static void consumeRegisteredConcept(Meta.Concept concept,
                                            Map<String,String> names,
                                            Consumer<String> action)

Utility function to apply a method for a given Meta.Concept name if provided in the given Map of names.

Parameters:

concept - The concept to check in the map if present.

names - A non-null map of concept names to their key names.

action - The action to apply if the concept was provided in the map.