Package org.apache.drill.common

Class PlanStringBuilder

java.lang.Object

org.apache.drill.common.PlanStringBuilder

public class PlanStringBuilder
extends Object

Builds a string in Drill's "plan string" format: that shown in the text version of EXPLAIN PLAN FOR output. Example:

 Mumble[foo=fred, bar=barney]

Similar to the Guava Objects.ToStringHelper class but for the Drill "plan-string" format. Use this class for any object that may be displayed in an query plan.

Example usage:

 public String toString() {
   return PlanStringBuilder(this)
     .field("foo", foo)
     .field("bar", bar)
     .toString();
 }

Constructor Summary

Constructors

Constructor	Description
PlanStringBuilder(Object node)
PlanStringBuilder(String node)

Method Summary

Modifier and Type	Method	Description
PlanStringBuilder	escapedField(String key, char value)	Displays a character in Java-quoted format: delimiter="\n".
PlanStringBuilder	escapedField(String key, String value)	Displays a string in Java-quoted format: delimiter="\t".
PlanStringBuilder	field(String key, int value)	Displays a numeric field: size=10.
PlanStringBuilder	field(String key, Object value)	Displays the field as an unquoted toString() value.
PlanStringBuilder	field(String key, String value)	Displays the field as a quoted string: foo="bar".
PlanStringBuilder	maskedField(String key, String value)
String	toString()
PlanStringBuilder	unquotedField(String key, String value)	Displays the field as an unquoted string.

Methods inherited from class java.lang.Object

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

Constructor Details

PlanStringBuilder

public PlanStringBuilder(Object node)

PlanStringBuilder

public PlanStringBuilder(String node)

Method Details

field

public PlanStringBuilder field(String key,
 String value)

Displays the field as a quoted string: foo="bar".

unquotedField

public PlanStringBuilder unquotedField(String key,
 String value)

Displays the field as an unquoted string. Use this for things like names: mode=OPTIONAL.

field

public PlanStringBuilder field(String key,
 Object value)

Displays the field as an unquoted toString() value. Omits the field if the value is null.

field

public PlanStringBuilder field(String key,
 int value)

Displays a numeric field: size=10.

escapedField

public PlanStringBuilder escapedField(String key,
 char value)

Displays a character in Java-quoted format: delimiter="\n".

escapedField

public PlanStringBuilder escapedField(String key,
 String value)

Displays a string in Java-quoted format: delimiter="\t".

maskedField

public PlanStringBuilder maskedField(String key,
 String value)

toString

public String toString()

Overrides:

toString in class Object