zserio.ast

Class SqlTableType

java.lang.Object

zserio.ast.AstNodeBase

zserio.ast.DocumentableAstNode

zserio.ast.CompoundType

zserio.ast.SqlTableType

All Implemented Interfaces:

AstNode, PackageSymbol, ZserioScopedType, ZserioTemplatableType, ZserioType

public final class SqlTableType
extends CompoundType

AST node for SQL Table types. SQL Ttypes are Zserio types as well.

Constructor Summary

Constructors

Constructor and Description
SqlTableType(AstLocation location, Package pkg, java.lang.String name, java.util.List<TemplateParameter> templateParameters, java.lang.String sqlUsingId, java.util.List<Field> fields, SqlConstraint sqlConstraint, boolean sqlWithoutRowId, java.util.List<DocComment> docComments) Constructor.

Method Summary

Modifier and Type	Method and Description
void	accept(ZserioAstVisitor visitor) Accept zserio visitor.
java.lang.String	getInstantiationName() Gets the unique instantiation name.
java.util.ArrayDeque<TypeReference>	getInstantiationReferenceStack() Gets stack of instantiations leading to this instantiation.
java.util.List<ZserioTemplatableType>	getInstantiations() Gets all template's instantiations.
java.util.ArrayDeque<TypeReference>	getReversedInstantiationReferenceStack() Gets reversed stack of instantiations leading to this instantiation.
SqlConstraint	getSqlConstraint() Gets SQL constraint defined in this SQL table.
ZserioTemplatableType	getTemplate() Gets original template used for instantiation.
java.util.List<TemplateParameter>	getTemplateParameters() Gets list of template parameters.
java.lang.String	getVirtualTableUsingString() Gets 'using' specification for SQL virtual tables.
boolean	isFieldPrimaryKey(Field field) Checks if given field is primary key in the table.
boolean	isWithoutRowId() Checks if the table has without rowid optimization.
boolean	needsTypesInSchema() Checks if this SQL table needs types specification in schema.
void	visitChildren(ZserioAstVisitor visitor) Visit children of the current AST node using given visitor.

Methods inherited from class zserio.ast.CompoundType

checkNonSqlTableFields, checkSqlSymbolNames, checkSqlTableFields, checkSymbolNames, containsExtendedField, getFields, getFunctions, getName, getPackage, getScope, getTypeParameters, hasBranchWithoutImplicitArray, hasEmptyBranch, hasFieldBranchWithoutImplicitArray, hasFieldEmptyBranch, hasPackableField, isPackable, needsChildrenInitialization, trackExtendedField, trackImplicitArray

Methods inherited from class zserio.ast.DocumentableAstNode

getDocComments

Methods inherited from class zserio.ast.AstNodeBase

getLocation

Methods inherited from class java.lang.Object

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

Methods inherited from interface zserio.ast.AstNode

getLocation

Constructor Detail

SqlTableType

public SqlTableType(AstLocation location,
                    Package pkg,
                    java.lang.String name,
                    java.util.List<TemplateParameter> templateParameters,
                    java.lang.String sqlUsingId,
                    java.util.List<Field> fields,
                    SqlConstraint sqlConstraint,
                    boolean sqlWithoutRowId,
                    java.util.List<DocComment> docComments)

Constructor.

Parameters:

location - AST node location.

pkg - Package to which belongs the SQL table type.

name - Name of the SQL table type.

templateParameters - List of template parameters.

sqlUsingId - SQL using id associated to the SQL table type.

fields - List of all fields of to the SQL table type.

sqlConstraint - SQL constraint of the SQL table type.

sqlWithoutRowId - SQL without row id associated to the SQL table type.

docComments - List of documentation comments belonging to this node.

Method Detail

accept

public void accept(ZserioAstVisitor visitor)

Description copied from interface: AstNode

Accept zserio visitor.

Parameters:

visitor - Visitor to accept.

visitChildren

public void visitChildren(ZserioAstVisitor visitor)

Description copied from interface: AstNode

Visit children of the current AST node using given visitor.

Specified by:

visitChildren in interface AstNode

Overrides:

visitChildren in class CompoundType

Parameters:

visitor - Visitor to use.

getVirtualTableUsingString

public java.lang.String getVirtualTableUsingString()

Gets 'using' specification for SQL virtual tables.

Returns:

'using' specification for SQL virtual tables or null if 'using' has not been specified.

needsTypesInSchema

public boolean needsTypesInSchema()

Checks if this SQL table needs types specification in schema. This method is needed to distinguish between FTS5 and other virtual tables because only FTS5 does not support types specification in schema.

Returns:

true if this SQL table needs types specification in schema.

getSqlConstraint

public SqlConstraint getSqlConstraint()

Gets SQL constraint defined in this SQL table.

Returns:

SQL constraint defined in this SQL table or null if it's not defined.

isFieldPrimaryKey

public boolean isFieldPrimaryKey(Field field)

Checks if given field is primary key in the table.

Parameters:

field - Field to check.

Returns:

true if given field is primary key or if it is part of composite primary key.

isWithoutRowId

public boolean isWithoutRowId()

Checks if the table has without rowid optimization.

Returns:

true if the table is without rowid, otherwise false.

getTemplateParameters

public java.util.List<TemplateParameter> getTemplateParameters()

Description copied from interface: ZserioTemplatableType

Gets list of template parameters.

Specified by:

getTemplateParameters in interface ZserioTemplatableType

Returns:

List of template parameters.

getInstantiations

public java.util.List<ZserioTemplatableType> getInstantiations()

Description copied from interface: ZserioTemplatableType

Gets all template's instantiations.

Specified by:

getInstantiations in interface ZserioTemplatableType

Returns:

List of all instantiations.

getTemplate

public ZserioTemplatableType getTemplate()

Description copied from interface: ZserioTemplatableType

Gets original template used for instantiation.

Specified by:

getTemplate in interface ZserioTemplatableType

Returns:

Template of the current instantiation or null when this is not an instantiation.

getInstantiationReferenceStack

public java.util.ArrayDeque<TypeReference> getInstantiationReferenceStack()

Description copied from interface: ZserioTemplatableType

Gets stack of instantiations leading to this instantiation.

Specified by:

getInstantiationReferenceStack in interface ZserioTemplatableType

Returns:

Stack of type references.

getReversedInstantiationReferenceStack

public java.util.ArrayDeque<TypeReference> getReversedInstantiationReferenceStack()

Description copied from interface: ZserioTemplatableType

Gets reversed stack of instantiations leading to this instantiation.

Specified by:

getReversedInstantiationReferenceStack in interface ZserioTemplatableType

Returns:

Stack of type references.

getInstantiationName

public java.lang.String getInstantiationName()

Description copied from interface: ZserioTemplatableType

Gets the unique instantiation name.

Specified by:

getInstantiationName in interface ZserioTemplatableType

Returns:

Instantiation name unique in the package where template is located.