ai.grakn.graql.internal.printer

Class Printer<Builder>

java.lang.Object

ai.grakn.graql.internal.printer.Printer<Builder>

Type Parameters:

Builder - An intermediate builder type that can be changed into a String

public abstract class Printer<Builder>
extends Object

An interface for print objects in Graql responses (e.g. Integers and ConceptMaps into a String). The intermediate Builder type is used when the final type is different to the "in-progress" type when creating it. For example, you may want to use a StringBuilder for Builder (for efficiency). If you don't need a Builder type, then set it to the same type as String and implement #complete(Builder) to just return its argument.

Author:

Grakn Warriors

Constructor Summary

Constructors

Constructor and Description
Printer()

Method Summary

Modifier and Type	Method and Description
protected abstract Builder	answerGroup(AnswerGroup<?> answer) Convert any AnswerGroup into its print builder
protected abstract Builder	bool(boolean bool) Convert any boolean into its print builder
protected Builder	build(Object object) Convert any object into its print builder
protected abstract Builder	collection(Collection<?> collection) Convert any collection into its print builder
protected abstract String	complete(Builder builder) Convert a builder into the final type
protected abstract Builder	concept(Concept concept) Convert any concept into its print builder
protected Builder	conceptList(ConceptList answer) Convert any ConceptList into its print builder
protected abstract Builder	conceptMap(ConceptMap answer) Convert any ConceptMap into its print builder
protected Builder	conceptSet(ConceptSet answer) Convert any ConceptSet into its print builder
protected abstract Builder	conceptSetMeasure(ConceptSetMeasure answer) Convert any ConceptSetMeasure into its print builder
static Printer<mjson.Json>	jsonPrinter() Constructs a special type of Printer: JsonPrinter
protected abstract Builder	map(Map<?,?> map) Convert any map into its print builder
protected abstract Builder	object(Object object) Default conversion behaviour if none of the more specific methods can be used
static Printer<StringBuilder>	stringPrinter(boolean colorize, AttributeType... attributeTypes) Constructs a special type of Printer: StringPrinter
java.util.stream.Stream<String>	toStream(java.util.stream.Stream<?> objects) Convert a stream of objects into a stream of Strings to be printed
String	toString(Object object) Convert any object into a String to be printed
protected Builder	value(Value answer) Convert any Value into its print builder

Methods inherited from class java.lang.Object

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

Constructor Detail

Printer

public Printer()

Method Detail

stringPrinter

public static Printer<StringBuilder> stringPrinter(boolean colorize,
                                                   AttributeType... attributeTypes)

Constructs a special type of Printer: StringPrinter

Parameters:

colorize - boolean parameter to determine if the String output should be colorized

attributeTypes - list of attribute types that should be included in the String output

Returns:

a new StringPrinter object

jsonPrinter

public static Printer<mjson.Json> jsonPrinter()

Constructs a special type of Printer: JsonPrinter

Returns:

a new JsonPrinter object

toStream

public java.util.stream.Stream<String> toStream(java.util.stream.Stream<?> objects)

Convert a stream of objects into a stream of Strings to be printed

Parameters:

objects - the objects to be printed

Returns:

the stream of String print output for the object

toString

@CheckReturnValue
public String toString(Object object)

Convert any object into a String to be printed

Parameters:

object - the object to be printed

Returns:

the String print output for the object

build

@CheckReturnValue
protected Builder build(Object object)

Convert any object into its print builder

Parameters:

object - the object to convert into its print builder

Returns:

the object as a builder

complete

@CheckReturnValue
protected abstract String complete(Builder builder)

Convert a builder into the final type

Parameters:

builder - the builder to convert into the final type

Returns:

the converted builder

concept

@CheckReturnValue
protected abstract Builder concept(Concept concept)

Convert any concept into its print builder

Parameters:

concept - the concept to convert into its print builder

Returns:

the concept as a builder

bool

@CheckReturnValue
protected abstract Builder bool(boolean bool)

Convert any boolean into its print builder

Parameters:

bool - the boolean to convert into its print builder

Returns:

the boolean as a builder

collection

@CheckReturnValue
protected abstract Builder collection(Collection<?> collection)

Convert any collection into its print builder

Parameters:

collection - the collection to convert into its print builder

Returns:

the collection as a builder

map

@CheckReturnValue
protected abstract Builder map(Map<?,?> map)

Convert any map into its print builder

Parameters:

map - the map to convert into its print builder

Returns:

the map as a builder

answerGroup

@CheckReturnValue
protected abstract Builder answerGroup(AnswerGroup<?> answer)

Convert any AnswerGroup into its print builder

Parameters:

answer - is the answer result of a Graql Compute queries

Returns:

the grouped answers as an output builder

conceptList

@CheckReturnValue
protected Builder conceptList(ConceptList answer)

Convert any ConceptList into its print builder

Parameters:

answer - is the answer result of a Graql Compute queries

Returns:

the concept list as an output builder

conceptMap

@CheckReturnValue
protected abstract Builder conceptMap(ConceptMap answer)

Convert any ConceptMap into its print builder

Parameters:

answer - is the answer result of a Graql Compute queries

Returns:

the concept map as an output builder

conceptSet

@CheckReturnValue
protected Builder conceptSet(ConceptSet answer)

Convert any ConceptSet into its print builder

Parameters:

answer - is the answer result of a Graql Compute queries

Returns:

the concept set as an output builder

conceptSetMeasure

@CheckReturnValue
protected abstract Builder conceptSetMeasure(ConceptSetMeasure answer)

Convert any ConceptSetMeasure into its print builder

Parameters:

answer - is the answer result of a Graql Compute queries

Returns:

the concept set measure as an output builder

value

@CheckReturnValue
protected Builder value(Value answer)

Convert any Value into its print builder

Parameters:

answer - is the answer result of a Graql Compute queries

Returns:

the number as an output builder

object

@CheckReturnValue
protected abstract Builder object(Object object)

Default conversion behaviour if none of the more specific methods can be used

Parameters:

object - the object to convert into its print builder

Returns:

the object as a builder