com.google.zetasql.resolvedast.AbstractDeserializationHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of zetasql-client Show documentation
Analyzer Framework for SQL
The newest version!
/*
 * Copyright 2019 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package com.google.zetasql.resolvedast;

import static com.google.common.base.Preconditions.checkNotNull;

import com.google.common.collect.ImmutableList;
import com.google.zetasql.Column;
import com.google.zetasql.ColumnRefProto;
import com.google.zetasql.Connection;
import com.google.zetasql.ConnectionRefProto;
import com.google.zetasql.Constant;
import com.google.zetasql.ConstantRefProto;
import com.google.zetasql.DescriptorPool;
import com.google.zetasql.DescriptorPool.ZetaSQLDescriptor;
import com.google.zetasql.DescriptorPool.ZetaSQLFieldDescriptor;
import com.google.zetasql.DescriptorPool.ZetaSQLOneofDescriptor;
import com.google.zetasql.FieldDescriptorRefProto;
import com.google.zetasql.Function;
import com.google.zetasql.FunctionProtos.FunctionSignatureProto;
import com.google.zetasql.FunctionProtos.ResolvedFunctionCallInfoProto;
import com.google.zetasql.FunctionProtos.TVFSignatureProto;
import com.google.zetasql.FunctionRefProto;
import com.google.zetasql.FunctionSignature;
import com.google.zetasql.ZetaSQLAnnotation.AnnotationMapProto;
import com.google.zetasql.ZetaSQLType.ProtoTypeProto;
import com.google.zetasql.ZetaSQLType.TypeProto;
import com.google.zetasql.ZetaSQLTypeModifiers.TypeModifiersProto;
import com.google.zetasql.ZetaSQLTypeParameters.TypeParametersProto;
import com.google.zetasql.GraphElementLabel;
import com.google.zetasql.GraphElementLabelRefProto;
import com.google.zetasql.GraphElementTable;
import com.google.zetasql.GraphElementTableRefProto;
import com.google.zetasql.GraphPropertyDeclaration;
import com.google.zetasql.GraphPropertyDeclarationRefProto;
import com.google.zetasql.Model;
import com.google.zetasql.ModelRefProto;
import com.google.zetasql.OneofDescriptorRefProto;
import com.google.zetasql.Procedure;
import com.google.zetasql.ProcedureRefProto;
import com.google.zetasql.PropertyGraph;
import com.google.zetasql.PropertyGraphRefProto;
import com.google.zetasql.ResolvedCollationProto;
import com.google.zetasql.ResolvedColumnProto;
import com.google.zetasql.ResolvedFunctionCallInfo;
import com.google.zetasql.Sequence;
import com.google.zetasql.SequenceRefProto;
import com.google.zetasql.TVFSignature;
import com.google.zetasql.Table;
import com.google.zetasql.TableRefProto;
import com.google.zetasql.TableValuedFunction;
import com.google.zetasql.TableValuedFunctionRefProto;
import com.google.zetasql.Type;
import com.google.zetasql.TypeFactory;
import com.google.zetasql.TypeParameters;
import com.google.zetasql.Value;
import com.google.zetasql.ValueWithTypeProto;
import javax.annotation.Nullable;

/** Deserializes objects in the ResolvedAST which require some context. */
public abstract class AbstractDeserializationHelper {
  private final TypeFactory typeFactory;
  private final ImmutableList pools;

  public AbstractDeserializationHelper(
      TypeFactory typeFactory, ImmutableList pools) {
    this.typeFactory = checkNotNull(typeFactory);
    this.pools = checkNotNull(pools);
  }

  ZetaSQLFieldDescriptor deserialize(FieldDescriptorRefProto proto) {
    ProtoTypeProto containingMessageProto = proto.getContainingProto();
    ZetaSQLDescriptor containingMessage =
        checkNotNull(
            checkNotNull(pools.get(containingMessageProto.getFileDescriptorSetIndex()))
                .findMessageTypeByName(containingMessageProto.getProtoName()),
            "Couldn't find pool for descriptor %s",
            containingMessageProto.getProtoName());
    return checkNotNull(containingMessage.findFieldByNumber(proto.getNumber()));
  }

  ZetaSQLOneofDescriptor deserialize(OneofDescriptorRefProto proto) {
    ProtoTypeProto containingMessageProto = proto.getContainingProto();
    ZetaSQLDescriptor containingMessage =
        checkNotNull(
            checkNotNull(pools.get(containingMessageProto.getFileDescriptorSetIndex()))
                .findMessageTypeByName(containingMessageProto.getProtoName()),
            "Couldn't find pool for descriptor %s",
            containingMessageProto.getProtoName());
    return checkNotNull(containingMessage.findOneofByIndex(proto.getIndex()));
  }

  abstract Constant deserialize(ConstantRefProto proto);

  abstract Function deserialize(FunctionRefProto proto);

  FunctionSignature deserialize(FunctionSignatureProto proto) {
    return FunctionSignature.deserialize(proto, pools);
  }

  abstract TableValuedFunction deserialize(TableValuedFunctionRefProto proto);

  ResolvedFunctionCallInfo deserialize(ResolvedFunctionCallInfoProto proto) {
    return ResolvedFunctionCallInfo.deserialize(proto, pools);
  }

  TVFSignature deserialize(TVFSignatureProto proto) {
    return TVFSignature.deserialize(proto, pools);
  }

  abstract Procedure deserialize(ProcedureRefProto proto);

  abstract Column deserialize(ColumnRefProto proto);

  abstract PropertyGraph deserialize(PropertyGraphRefProto proto);

  abstract GraphPropertyDeclaration deserialize(GraphPropertyDeclarationRefProto proto);

  abstract GraphElementLabel deserialize(GraphElementLabelRefProto proto);

  abstract GraphElementTable deserialize(GraphElementTableRefProto proto);

  ResolvedColumn deserialize(ResolvedColumnProto proto) {
    return new ResolvedColumn(
        proto.getColumnId(),
        proto.getTableName(),
        proto.getName(),
        deserialize(proto.getType()));
  }

  abstract Model deserialize(ModelRefProto proto);

  abstract Connection deserialize(ConnectionRefProto proto);

  abstract Sequence deserialize(SequenceRefProto proto);

  @Nullable
  abstract Table deserialize(TableRefProto proto);

  Type deserialize(TypeProto proto) {
    return typeFactory.deserialize(proto, pools);
  }

  Value deserialize(ValueWithTypeProto proto) {
    if (!(proto.hasType() && proto.hasValue())) {
      return new Value(); // Invalid value.
    }
    return Value.deserialize(deserialize(proto.getType()), proto.getValue());
  }

  @Nullable
  AnnotationMap deserialize(AnnotationMapProto proto) {
    // TODO: use TypeFactory to create AnnotatedType.
    return null;
  }

  ResolvedCollation deserialize(ResolvedCollationProto proto) {
    return ResolvedCollation.deserialize(proto);
  }

  TypeModifiers deserialize(TypeModifiersProto proto) {
    return TypeModifiers.deserialize(proto);
  }

  TypeParameters deserialize(TypeParametersProto proto) {
    return TypeParameters.deserialize(proto);
  }
}