io.crate.metadata

Class ColumnIdent

java.lang.Object

io.crate.metadata.ColumnIdent

All Implemented Interfaces:

Path, java.lang.Comparable<ColumnIdent>, org.elasticsearch.common.io.stream.Streamable

public class ColumnIdent
extends java.lang.Object
implements Path, java.lang.Comparable<ColumnIdent>, org.elasticsearch.common.io.stream.Streamable

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.base.Function<ColumnIdent,java.lang.String>	GET_FQN_NAME_FUNCTION
static com.google.common.base.Predicate<java.lang.CharSequence>	INVALID_COLUMN_NAME_PREDICATE

Constructor Summary

Constructors

Constructor and Description
ColumnIdent(java.lang.String name)
ColumnIdent(java.lang.String name, java.util.List<java.lang.String> path)
ColumnIdent(java.lang.String name, java.lang.String childName)

Method Summary

Modifier and Type	Method and Description
int	compareTo(ColumnIdent o)
boolean	equals(java.lang.Object obj)
java.lang.String	fqn()
static ColumnIdent	fromPath(java.lang.String path)
static ColumnIdent	fromStream(org.elasticsearch.common.io.stream.StreamInput in)
static ColumnIdent	getChild(ColumnIdent parent, java.lang.String name)
ColumnIdent	getParent() person['addresses']['street'] --> person['addresses']
ColumnIdent	getRoot() person['addresses']['street'] --> person
int	hashCode()
boolean	isChildOf(ColumnIdent parentIdent) checks whether this ColumnIdent is a child of parentIdent
boolean	isColumn()
boolean	isSystemColumn() returns true if this is a system column
java.lang.String	name()
java.lang.String	outputName()
java.util.List<java.lang.String>	path()
ColumnIdent	prepend(java.lang.String name) Create a new ColumnIdent with the name inserted at the start E.g.
java.lang.String	quotedOutputName()
void	readFrom(org.elasticsearch.common.io.stream.StreamInput in)
ColumnIdent	shiftRight() creates a new columnIdent which just consists of the path of the given columnIdent e.g.
java.lang.String	sqlFqn()
java.lang.String	toString()
void	writeTo(org.elasticsearch.common.io.stream.StreamOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

INVALID_COLUMN_NAME_PREDICATE

public static final com.google.common.base.Predicate<java.lang.CharSequence> INVALID_COLUMN_NAME_PREDICATE

GET_FQN_NAME_FUNCTION

public static final com.google.common.base.Function<ColumnIdent,java.lang.String> GET_FQN_NAME_FUNCTION

Constructor Detail

ColumnIdent

public ColumnIdent(java.lang.String name)

ColumnIdent

public ColumnIdent(java.lang.String name,
                   java.lang.String childName)

ColumnIdent

public ColumnIdent(java.lang.String name,
                   @Nullable
                   java.util.List<java.lang.String> path)

Method Detail

fromStream

public static ColumnIdent fromStream(org.elasticsearch.common.io.stream.StreamInput in)
                              throws java.io.IOException

Throws:

java.io.IOException

fromPath

public static ColumnIdent fromPath(@Nullable
                                   java.lang.String path)

getChild

public static ColumnIdent getChild(ColumnIdent parent,
                                   java.lang.String name)

isChildOf

public boolean isChildOf(ColumnIdent parentIdent)

checks whether this ColumnIdent is a child of parentIdent

Parameters:

parentIdent - the ident to check for parenthood

Returns:

true if parentIdent is parentIdent of this, false otherwise.

getParent

public ColumnIdent getParent()

person['addresses']['street'] --> person['addresses']

person --> null

shiftRight

@Nullable
public ColumnIdent shiftRight()

creates a new columnIdent which just consists of the path of the given columnIdent e.g.

foo['x']['y']

becomes

 x['y']

If the columnIdent doesn't have a path the return value is null

isSystemColumn

public boolean isSystemColumn()

returns true if this is a system column

getRoot

public ColumnIdent getRoot()

person['addresses']['street'] --> person

person --> person

name

public java.lang.String name()

fqn

public java.lang.String fqn()

outputName

public java.lang.String outputName()

Specified by:

outputName in interface Path

quotedOutputName

public java.lang.String quotedOutputName()

sqlFqn

public java.lang.String sqlFqn()

path

public java.util.List<java.lang.String> path()

isColumn

public boolean isColumn()

Returns:

true if this is a top level column, otherwise false

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(ColumnIdent o)

Specified by:

compareTo in interface java.lang.Comparable<ColumnIdent>

readFrom

public void readFrom(org.elasticsearch.common.io.stream.StreamInput in)
              throws java.io.IOException

Specified by:

readFrom in interface org.elasticsearch.common.io.stream.Streamable

Throws:

java.io.IOException

writeTo

public void writeTo(org.elasticsearch.common.io.stream.StreamOutput out)
             throws java.io.IOException

Specified by:

writeTo in interface org.elasticsearch.common.io.stream.Streamable

Throws:

java.io.IOException

prepend

public ColumnIdent prepend(java.lang.String name)

Create a new ColumnIdent with the name inserted at the start E.g. ColumnIdent y['z'].prepend('x') becomes ColumnIdent x['y']['z']