Package org.apache.cassandra.schema

Class ViewMetadata

java.lang.Object

org.apache.cassandra.schema.ViewMetadata

All Implemented Interfaces:

SchemaElement

public final class ViewMetadata
extends Object
implements SchemaElement

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.cassandra.cql3.SchemaElement

SchemaElement.SchemaElementType

Field Summary

Fields

Modifier and Type	Field	Description
final TableId	baseTableId
final String	baseTableName
final boolean	includeAllColumns
final TableMetadata	metadata
final WhereClause	whereClause

Fields inherited from interface org.apache.cassandra.cql3.SchemaElement

NAME_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
ViewMetadata(TableId baseTableId, String baseTableName, boolean includeAllColumns, WhereClause whereClause, TableMetadata metadata)

Method Summary

Modifier and Type	Method	Description
void	appendCqlTo(CqlBuilder builder, boolean internals, boolean ifNotExists)
TableMetadata	baseTableMetadata()
ViewMetadata	copy(TableMetadata newMetadata)
String	elementKeyspace()	Returns the CQL name of the keyspace to which this schema element belong.
String	elementName()	Returns the CQL name of this schema element.
SchemaElement.SchemaElementType	elementType()	Return the schema element type
boolean	equals(Object o)
int	hashCode()
boolean	includes(ColumnIdentifier column)
String	keyspace()
String	name()
boolean	referencesUserType(ByteBuffer name)
String	toCqlString(boolean withInternals, boolean ifNotExists)	Returns a CQL representation of this element
String	toString()
ViewMetadata	withAddedRegularColumn(ColumnMetadata column)
ViewMetadata	withNewColumnMask(ColumnIdentifier name, ColumnMask mask)
ViewMetadata	withRenamedPrimaryKeyColumn(ColumnIdentifier from, ColumnIdentifier to)
ViewMetadata	withUpdatedUserType(UserType udt)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.cassandra.cql3.SchemaElement

elementKeyspaceQuotedIfNeeded, elementNameQuotedIfNeeded

Field Details

baseTableId

public final TableId baseTableId

baseTableName

public final String baseTableName

includeAllColumns

public final boolean includeAllColumns

metadata

public final TableMetadata metadata

whereClause

public final WhereClause whereClause

Constructor Details

ViewMetadata

public ViewMetadata(TableId baseTableId,
 String baseTableName,
 boolean includeAllColumns,
 WhereClause whereClause,
 TableMetadata metadata)

Parameters:

baseTableId - Internal ID of the table which this view is based off of

includeAllColumns - Whether to include all columns or not

Method Details

keyspace

public String keyspace()

name

public String name()

includes

public boolean includes(ColumnIdentifier column)

Returns:

true if the view specified by this definition will include the column, false otherwise

copy

public ViewMetadata copy(TableMetadata newMetadata)

baseTableMetadata

public TableMetadata baseTableMetadata()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

referencesUserType

public boolean referencesUserType(ByteBuffer name)

withUpdatedUserType

public ViewMetadata withUpdatedUserType(UserType udt)

withRenamedPrimaryKeyColumn

public ViewMetadata withRenamedPrimaryKeyColumn(ColumnIdentifier from,
 ColumnIdentifier to)

withAddedRegularColumn

public ViewMetadata withAddedRegularColumn(ColumnMetadata column)

withNewColumnMask

public ViewMetadata withNewColumnMask(ColumnIdentifier name,
 @Nullable
 ColumnMask mask)

appendCqlTo

public void appendCqlTo(CqlBuilder builder,
 boolean internals,
 boolean ifNotExists)

elementType

public SchemaElement.SchemaElementType elementType()

Description copied from interface: SchemaElement

Return the schema element type

Specified by:

elementType in interface SchemaElement

Returns:

the schema element type

elementKeyspace

public String elementKeyspace()

Description copied from interface: SchemaElement

Returns the CQL name of the keyspace to which this schema element belong.

Specified by:

elementKeyspace in interface SchemaElement

Returns:

the keyspace name.

elementName

public String elementName()

Description copied from interface: SchemaElement

Returns the CQL name of this schema element.

Specified by:

elementName in interface SchemaElement

Returns:

the name of this schema element.

toCqlString

public String toCqlString(boolean withInternals,
 boolean ifNotExists)

Description copied from interface: SchemaElement

Returns a CQL representation of this element

Specified by:

toCqlString in interface SchemaElement

Parameters:

withInternals - if the internals part of the CQL should be exposed.

ifNotExists - if "IF NOT EXISTS" should be included.

Returns:

a CQL representation of this element