com.datastax.oss.dsbulk.mapping

Class MappingInspector

java.lang.Object

org.antlr.v4.runtime.tree.AbstractParseTreeVisitor<T>

com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor<MappingToken>

com.datastax.oss.dsbulk.mapping.MappingInspector

All Implemented Interfaces:

com.datastax.oss.dsbulk.generated.mapping.MappingVisitor<MappingToken>, org.antlr.v4.runtime.tree.ParseTreeVisitor<MappingToken>

public class MappingInspector
extends com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor<MappingToken>

Field Summary

Fields

Modifier and Type	Field and Description
static CQLWord	STAR
static CQLWord	TTL
static CQLWord	WRITETIME

Constructor Summary

Constructors

Constructor and Description
MappingInspector(String mapping, boolean write, MappingPreference mappingPreference)
MappingInspector(String mapping, boolean write, MappingPreference mappingPreference, Supplier<CQLWord> usingTimestampVariable, Supplier<CQLWord> usingTTLVariable) Deprecated. As of DSBulk 1.8.0, the mapping inspector deprecates the special __ttl and __timestamp tokens; these will be removed in a future release. Therefore, providing external names for these tokens will also cease to be supported in a future release.

Method Summary

Modifier and Type	Method and Description
List<CQLWord>	getExcludedVariables()
com.datastax.oss.driver.shaded.guava.common.collect.ImmutableMultimap<MappingField,CQLFragment>	getExplicitMappings()
boolean	isInferring()
static com.datastax.oss.driver.shaded.guava.common.collect.LinkedHashMultimap<MappingField,CQLFragment>	sortFieldsByIndex(com.datastax.oss.driver.shaded.guava.common.collect.Multimap<MappingField,CQLFragment> unsorted)
CQLWord	visitColumnName(com.datastax.oss.dsbulk.generated.mapping.MappingParser.ColumnNameContext ctx) Visit a parse tree produced by MappingParser.columnName().
MappedMappingField	visitField(com.datastax.oss.dsbulk.generated.mapping.MappingParser.FieldContext ctx) Visit a parse tree produced by MappingParser.field().
MappingField	visitFieldOrFunction(com.datastax.oss.dsbulk.generated.mapping.MappingParser.FieldOrFunctionContext ctx) Visit a parse tree produced by MappingParser.fieldOrFunction().
FunctionCall	visitFunction(com.datastax.oss.dsbulk.generated.mapping.MappingParser.FunctionContext ctx) Visit a parse tree produced by MappingParser.function().
CQLFragment	visitFunctionArg(com.datastax.oss.dsbulk.generated.mapping.MappingParser.FunctionArgContext ctx) Visit a parse tree produced by MappingParser.functionArg().
CQLWord	visitFunctionName(com.datastax.oss.dsbulk.generated.mapping.MappingParser.FunctionNameContext ctx) Visit a parse tree produced by MappingParser.functionName().
CQLWord	visitIdentifier(com.datastax.oss.dsbulk.generated.mapping.MappingParser.IdentifierContext ctx) Visit a parse tree produced by MappingParser.identifier().
MappingField	visitIndex(com.datastax.oss.dsbulk.generated.mapping.MappingParser.IndexContext ctx) Visit a parse tree produced by MappingParser.index().
MappingToken	visitIndexedEntry(com.datastax.oss.dsbulk.generated.mapping.MappingParser.IndexedEntryContext ctx) Visit a parse tree produced by MappingParser.indexedEntry().
MappingField	visitIndexOrFunction(com.datastax.oss.dsbulk.generated.mapping.MappingParser.IndexOrFunctionContext ctx) Visit a parse tree produced by MappingParser.indexOrFunction().
MappingToken	visitInferredMappedEntry(com.datastax.oss.dsbulk.generated.mapping.MappingParser.InferredMappedEntryContext ctx) Visit a parse tree produced by MappingParser.inferredMappedEntry().
CQLWord	visitKeyspaceName(com.datastax.oss.dsbulk.generated.mapping.MappingParser.KeyspaceNameContext ctx) Visit a parse tree produced by MappingParser.keyspaceName().
CQLLiteral	visitLiteral(com.datastax.oss.dsbulk.generated.mapping.MappingParser.LiteralContext ctx) Visit a parse tree produced by MappingParser.literal().
MappingToken	visitMapping(com.datastax.oss.dsbulk.generated.mapping.MappingParser.MappingContext ctx) Visit a parse tree produced by MappingParser.mapping().
MappingToken	visitRegularMappedEntry(com.datastax.oss.dsbulk.generated.mapping.MappingParser.RegularMappedEntryContext ctx) Visit a parse tree produced by MappingParser.regularMappedEntry().
MappingToken	visitSimpleEntry(com.datastax.oss.dsbulk.generated.mapping.MappingParser.SimpleEntryContext ctx) Visit a parse tree produced by MappingParser.simpleEntry().
FunctionCall	visitTtl(com.datastax.oss.dsbulk.generated.mapping.MappingParser.TtlContext ctx) Visit a parse tree produced by MappingParser.ttl().
CQLWord	visitVariable(com.datastax.oss.dsbulk.generated.mapping.MappingParser.VariableContext ctx) Visit a parse tree produced by MappingParser.variable().
CQLFragment	visitVariableOrFunction(com.datastax.oss.dsbulk.generated.mapping.MappingParser.VariableOrFunctionContext ctx) Visit a parse tree produced by MappingParser.variableOrFunction().
FunctionCall	visitWritetime(com.datastax.oss.dsbulk.generated.mapping.MappingParser.WritetimeContext ctx) Visit a parse tree produced by MappingParser.writetime().

Methods inherited from class com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor

visitFunctionArgs, visitMappedEntry, visitQualifiedFunctionName

Methods inherited from class org.antlr.v4.runtime.tree.AbstractParseTreeVisitor

aggregateResult, defaultResult, shouldVisitNextChild, visit, visitChildren, visitErrorNode, visitTerminal

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.antlr.v4.runtime.tree.ParseTreeVisitor

visit, visitChildren, visitErrorNode, visitTerminal

Field Detail

WRITETIME

public static final CQLWord WRITETIME

TTL

public static final CQLWord TTL

STAR

public static final CQLWord STAR

Constructor Detail

MappingInspector

public MappingInspector(@NonNull
                        String mapping,
                        boolean write,
                        @NonNull
                        MappingPreference mappingPreference)

MappingInspector

@Deprecated
public MappingInspector(@NonNull
                                    String mapping,
                                    boolean write,
                                    @NonNull
                                    MappingPreference mappingPreference,
                                    @Nullable
                                    Supplier<CQLWord> usingTimestampVariable,
                                    @Nullable
                                    Supplier<CQLWord> usingTTLVariable)

Deprecated. As of DSBulk 1.8.0, the mapping inspector deprecates the special __ttl and __timestamp tokens; these will be removed in a future release. Therefore, providing external names for these tokens will also cease to be supported in a future release.

Parameters:

usingTimestampVariable - The name of the USING TIMESTAMP variable, or empty if no such variable, or null if no query at all.

usingTTLVariable - The name of the USING TTL variable, or empty if no such variable, or null if no query at all.

Method Detail

getExplicitMappings

public com.datastax.oss.driver.shaded.guava.common.collect.ImmutableMultimap<MappingField,CQLFragment> getExplicitMappings()

Returns:

a map from field names to variable names containing the explicit (i.e., non-inferred) variables found in the mapping.

isInferring

public boolean isInferring()

Returns:

true if the mapping contains an inferred entry (such as "*=*"), false otherwise.

getExcludedVariables

public List<CQLWord> getExcludedVariables()

Returns:

the list of variables to exclude from the inferred mapping, as in "* = -c1". Returns empty if there is no such variable of if the mapping does not contain an inferred entry.

visitMapping

public MappingToken visitMapping(com.datastax.oss.dsbulk.generated.mapping.MappingParser.MappingContext ctx)

Description copied from class: com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor

Visit a parse tree produced by MappingParser.mapping().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitMapping in interface com.datastax.oss.dsbulk.generated.mapping.MappingVisitor<MappingToken>

Overrides:

visitMapping in class com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor<MappingToken>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitSimpleEntry

public MappingToken visitSimpleEntry(com.datastax.oss.dsbulk.generated.mapping.MappingParser.SimpleEntryContext ctx)

Description copied from class: com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor

Visit a parse tree produced by MappingParser.simpleEntry().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitSimpleEntry in interface com.datastax.oss.dsbulk.generated.mapping.MappingVisitor<MappingToken>

Overrides:

visitSimpleEntry in class com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor<MappingToken>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitRegularMappedEntry

public MappingToken visitRegularMappedEntry(com.datastax.oss.dsbulk.generated.mapping.MappingParser.RegularMappedEntryContext ctx)

Description copied from class: com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor

Visit a parse tree produced by MappingParser.regularMappedEntry().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitRegularMappedEntry in interface com.datastax.oss.dsbulk.generated.mapping.MappingVisitor<MappingToken>

Overrides:

visitRegularMappedEntry in class com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor<MappingToken>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitIndexedEntry

public MappingToken visitIndexedEntry(com.datastax.oss.dsbulk.generated.mapping.MappingParser.IndexedEntryContext ctx)

Description copied from class: com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor

Visit a parse tree produced by MappingParser.indexedEntry().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitIndexedEntry in interface com.datastax.oss.dsbulk.generated.mapping.MappingVisitor<MappingToken>

Overrides:

visitIndexedEntry in class com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor<MappingToken>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitInferredMappedEntry

public MappingToken visitInferredMappedEntry(com.datastax.oss.dsbulk.generated.mapping.MappingParser.InferredMappedEntryContext ctx)

Description copied from class: com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor

Visit a parse tree produced by MappingParser.inferredMappedEntry().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitInferredMappedEntry in interface com.datastax.oss.dsbulk.generated.mapping.MappingVisitor<MappingToken>

Overrides:

visitInferredMappedEntry in class com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor<MappingToken>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitIndexOrFunction

public MappingField visitIndexOrFunction(com.datastax.oss.dsbulk.generated.mapping.MappingParser.IndexOrFunctionContext ctx)

Description copied from class: com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor

Visit a parse tree produced by MappingParser.indexOrFunction().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitIndexOrFunction in interface com.datastax.oss.dsbulk.generated.mapping.MappingVisitor<MappingToken>

Overrides:

visitIndexOrFunction in class com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor<MappingToken>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitFieldOrFunction

@NonNull
public MappingField visitFieldOrFunction(com.datastax.oss.dsbulk.generated.mapping.MappingParser.FieldOrFunctionContext ctx)

Description copied from class: com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor

Visit a parse tree produced by MappingParser.fieldOrFunction().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitFieldOrFunction in interface com.datastax.oss.dsbulk.generated.mapping.MappingVisitor<MappingToken>

Overrides:

visitFieldOrFunction in class com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor<MappingToken>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitVariableOrFunction

@NonNull
public CQLFragment visitVariableOrFunction(com.datastax.oss.dsbulk.generated.mapping.MappingParser.VariableOrFunctionContext ctx)

Description copied from class: com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor

Visit a parse tree produced by MappingParser.variableOrFunction().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitVariableOrFunction in interface com.datastax.oss.dsbulk.generated.mapping.MappingVisitor<MappingToken>

Overrides:

visitVariableOrFunction in class com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor<MappingToken>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitIndex

public MappingField visitIndex(com.datastax.oss.dsbulk.generated.mapping.MappingParser.IndexContext ctx)

Description copied from class: com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor

Visit a parse tree produced by MappingParser.index().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitIndex in interface com.datastax.oss.dsbulk.generated.mapping.MappingVisitor<MappingToken>

Overrides:

visitIndex in class com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor<MappingToken>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitField

@NonNull
public MappedMappingField visitField(com.datastax.oss.dsbulk.generated.mapping.MappingParser.FieldContext ctx)

Description copied from class: com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor

Visit a parse tree produced by MappingParser.field().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitField in interface com.datastax.oss.dsbulk.generated.mapping.MappingVisitor<MappingToken>

Overrides:

visitField in class com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor<MappingToken>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitVariable

@NonNull
public CQLWord visitVariable(com.datastax.oss.dsbulk.generated.mapping.MappingParser.VariableContext ctx)

Description copied from class: com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor

Visit a parse tree produced by MappingParser.variable().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitVariable in interface com.datastax.oss.dsbulk.generated.mapping.MappingVisitor<MappingToken>

Overrides:

visitVariable in class com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor<MappingToken>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitFunction

@NonNull
public FunctionCall visitFunction(com.datastax.oss.dsbulk.generated.mapping.MappingParser.FunctionContext ctx)

Description copied from class: com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor

Visit a parse tree produced by MappingParser.function().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitFunction in interface com.datastax.oss.dsbulk.generated.mapping.MappingVisitor<MappingToken>

Overrides:

visitFunction in class com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor<MappingToken>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitWritetime

public FunctionCall visitWritetime(com.datastax.oss.dsbulk.generated.mapping.MappingParser.WritetimeContext ctx)

Description copied from class: com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor

Visit a parse tree produced by MappingParser.writetime().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitWritetime in interface com.datastax.oss.dsbulk.generated.mapping.MappingVisitor<MappingToken>

Overrides:

visitWritetime in class com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor<MappingToken>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitTtl

public FunctionCall visitTtl(com.datastax.oss.dsbulk.generated.mapping.MappingParser.TtlContext ctx)

Description copied from class: com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor

Visit a parse tree produced by MappingParser.ttl().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitTtl in interface com.datastax.oss.dsbulk.generated.mapping.MappingVisitor<MappingToken>

Overrides:

visitTtl in class com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor<MappingToken>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitKeyspaceName

public CQLWord visitKeyspaceName(com.datastax.oss.dsbulk.generated.mapping.MappingParser.KeyspaceNameContext ctx)

Description copied from class: com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor

Visit a parse tree produced by MappingParser.keyspaceName().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitKeyspaceName in interface com.datastax.oss.dsbulk.generated.mapping.MappingVisitor<MappingToken>

Overrides:

visitKeyspaceName in class com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor<MappingToken>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitFunctionName

@NonNull
public CQLWord visitFunctionName(com.datastax.oss.dsbulk.generated.mapping.MappingParser.FunctionNameContext ctx)

Description copied from class: com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor

Visit a parse tree produced by MappingParser.functionName().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitFunctionName in interface com.datastax.oss.dsbulk.generated.mapping.MappingVisitor<MappingToken>

Overrides:

visitFunctionName in class com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor<MappingToken>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitColumnName

public CQLWord visitColumnName(com.datastax.oss.dsbulk.generated.mapping.MappingParser.ColumnNameContext ctx)

Description copied from class: com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor

Visit a parse tree produced by MappingParser.columnName().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitColumnName in interface com.datastax.oss.dsbulk.generated.mapping.MappingVisitor<MappingToken>

Overrides:

visitColumnName in class com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor<MappingToken>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitIdentifier

public CQLWord visitIdentifier(com.datastax.oss.dsbulk.generated.mapping.MappingParser.IdentifierContext ctx)

Description copied from class: com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor

Visit a parse tree produced by MappingParser.identifier().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitIdentifier in interface com.datastax.oss.dsbulk.generated.mapping.MappingVisitor<MappingToken>

Overrides:

visitIdentifier in class com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor<MappingToken>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitFunctionArg

@NonNull
public CQLFragment visitFunctionArg(com.datastax.oss.dsbulk.generated.mapping.MappingParser.FunctionArgContext ctx)

Description copied from class: com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor

Visit a parse tree produced by MappingParser.functionArg().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitFunctionArg in interface com.datastax.oss.dsbulk.generated.mapping.MappingVisitor<MappingToken>

Overrides:

visitFunctionArg in class com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor<MappingToken>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitLiteral

public CQLLiteral visitLiteral(com.datastax.oss.dsbulk.generated.mapping.MappingParser.LiteralContext ctx)

Description copied from class: com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor

Visit a parse tree produced by MappingParser.literal().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitLiteral in interface com.datastax.oss.dsbulk.generated.mapping.MappingVisitor<MappingToken>

Overrides:

visitLiteral in class com.datastax.oss.dsbulk.generated.mapping.MappingBaseVisitor<MappingToken>

Parameters:

ctx - the parse tree

Returns:

the visitor result

sortFieldsByIndex

public static com.datastax.oss.driver.shaded.guava.common.collect.LinkedHashMultimap<MappingField,CQLFragment> sortFieldsByIndex(com.datastax.oss.driver.shaded.guava.common.collect.Multimap<MappingField,CQLFragment> unsorted)