org.springframework.cassandra.core.cql

Class CqlIdentifier

java.lang.Object

org.springframework.cassandra.core.cql.CqlIdentifier

All Implemented Interfaces:

Serializable, Comparable<CqlIdentifier>

public final class CqlIdentifier
extends Object
implements Comparable<CqlIdentifier>, Serializable

This encapsulates the logic for CQL quoted and unquoted identifiers.

CQL identifiers, when unquoted, are converted to lower case. When quoted, they are returned as-is with no lower casing and encased in double quotes. To render, use any of the methods toCql(), toCql(StringBuilder), or toString().

Author:

John McPeek, Matthew T. Adams, Mark Paluch, John Blum

See Also:

toCql(), toCql(StringBuilder), toString(), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	QUOTED
static String	QUOTED_REGEX
static Pattern	UNQUOTED
static String	UNQUOTED_REGEX

Constructor Summary

Constructors

Constructor and Description
CqlIdentifier(CharSequence identifier) Creates a new CqlIdentifier without force-quoting it.
CqlIdentifier(CharSequence identifier, boolean forceQuote) Creates a new CQL identifier, optionally force-quoting it.

Method Summary

Modifier and Type	Method and Description
int	compareTo(CqlIdentifier identifier) Unquoted identifiers sort before quoted ones.
static CqlIdentifier	cqlId(CharSequence identifier) Factory method for CqlIdentifier.
static CqlIdentifier	cqlId(CharSequence identifier, boolean forceQuote) Factory method for CqlIdentifier.
boolean	equals(Object obj) Compares this CqlIdentifier to the given object.
String	getUnquoted() Returns the identifier without encasing quotes, regardless of the value of isQuoted().
int	hashCode()
boolean	isQuoted() Whether or not this identifier is quoted.
static boolean	isQuotedIdentifier(CharSequence chars) Returns true if the given CharSequence is a legal unquoted identifier.
static boolean	isUnquotedIdentifier(CharSequence chars) Returns true if the given CharSequence is a legal unquoted identifier.
static CqlIdentifier	quotedCqlId(CharSequence identifier) Factory method for a force-quoted CqlIdentifier.
String	toCql() Renders this identifier appropriately.
StringBuilder	toCql(StringBuilder builder) Appends the rendering of this identifier to the given StringBuilder, then returns that StringBuilder.
String	toString() Alias for toCql().

Methods inherited from class java.lang.Object

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

Field Detail

UNQUOTED_REGEX

public static final String UNQUOTED_REGEX

See Also:

Constant Field Values

UNQUOTED

public static final Pattern UNQUOTED

QUOTED_REGEX

public static final String QUOTED_REGEX

See Also:

Constant Field Values

QUOTED

public static final Pattern QUOTED

Constructor Detail

CqlIdentifier

public CqlIdentifier(CharSequence identifier)

Creates a new CqlIdentifier without force-quoting it. It may end up quoted, depending on its value.

See Also:

cqlId(CharSequence)

CqlIdentifier

public CqlIdentifier(CharSequence identifier,
                     boolean forceQuote)

Creates a new CQL identifier, optionally force-quoting it. Force-quoting can be used to preserve identifier case.

• If the given identifier is a legal quoted identifier or forceQuote is true, isQuoted() will return true and the identifier will be quoted when rendered.
• If the given identifier is a legal unquoted identifier, isQuoted() will return false, plus the name will be converted to lower case and rendered as such.
• If the given identifier is illegal, an IllegalArgumentException is thrown.

See Also:

cqlId(CharSequence, boolean), quotedCqlId(CharSequence)

Method Detail

cqlId

public static CqlIdentifier cqlId(CharSequence identifier)

Factory method for CqlIdentifier. Convenient if imported statically.

See Also:

CqlIdentifier(CharSequence)

cqlId

public static CqlIdentifier cqlId(CharSequence identifier,
                                  boolean forceQuote)

Factory method for CqlIdentifier. Convenient if imported statically.

See Also:

CqlIdentifier(CharSequence, boolean)

quotedCqlId

public static CqlIdentifier quotedCqlId(CharSequence identifier)

Factory method for a force-quoted CqlIdentifier. Convenient if imported statically.

See Also:

CqlIdentifier(CharSequence, boolean)

isUnquotedIdentifier

public static boolean isUnquotedIdentifier(CharSequence chars)

Returns true if the given CharSequence is a legal unquoted identifier.

isQuotedIdentifier

public static boolean isQuotedIdentifier(CharSequence chars)

Returns true if the given CharSequence is a legal unquoted identifier.

getUnquoted

public String getUnquoted()

Returns the identifier without encasing quotes, regardless of the value of isQuoted(). For example, if isQuoted() is true, then this value will be the same as toCql() and toString().

This is needed, for example, to get the correct TableMetadata from KeyspaceMetadata.getTable(String): the given string must not be quoted.

toCql

public String toCql()

Renders this identifier appropriately.

toCql

public StringBuilder toCql(StringBuilder builder)

Appends the rendering of this identifier to the given StringBuilder, then returns that StringBuilder. If null is given, a new StringBuilder is created, appended to, and returned.

isQuoted

public boolean isQuoted()

Whether or not this identifier is quoted.

compareTo

public int compareTo(CqlIdentifier identifier)

Unquoted identifiers sort before quoted ones. Otherwise, they compare according to their identifiers.

Specified by:

compareTo in interface Comparable<CqlIdentifier>

equals

public boolean equals(Object obj)

Compares this CqlIdentifier to the given object. Note that if a CharSequence is given, a new CqlIdentifier is created from it and compared, such that a CharSequence can be effectively equal to a CqlIdentifier.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Alias for toCql().

Overrides:

toString in class Object