com.google.appengine.api.datastore.EntityProtoComparators Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of appengine-api-1.0-sdk
API for Google App Engine standard environment with some of the dependencies shaded (repackaged)
There is a newer version: 2.0.27
/*
 * Copyright 2021 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
 *
 *     https://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.appengine.api.datastore;

import com.google.apphosting.datastore.DatastoreV3Pb.Query.Filter;
import com.google.apphosting.datastore.DatastoreV3Pb.Query.Order;
import com.google.storage.onestore.v3.OnestoreEntity;
import com.google.storage.onestore.v3.OnestoreEntity.EntityProto;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import org.checkerframework.checker.nullness.qual.Nullable;

/**
 * Utilities for comparing {@link EntityProto}. This class is only public because the dev appserver
 * needs access to it. It should not be accessed by user code.
 *
 */
public final class EntityProtoComparators {

  public static final Comparator> MULTI_TYPE_COMPARATOR =
      BaseEntityComparator.MULTI_TYPE_COMPARATOR;

  /**
   * A comparator for {@link com.google.storage.onestore.v3.OnestoreEntity.EntityProto} objects with
   * the same ordering as {@link EntityComparator}.
   */
  public static final class EntityProtoComparator
      extends BaseEntityComparator {

    public EntityProtoComparator(List orders) {
      super(orders, Collections.emptyList());
    }

    public EntityProtoComparator(List orders, List filters) {
      super(orders, filters);
    }

    public List getAdjustedOrders() {
      return Collections.unmodifiableList(orders);
    }

    public boolean matches(OnestoreEntity.EntityProto proto) {
      for (String property : filters.keySet()) {
        List> values = getComparablePropertyValues(proto, property);
        if (values == null || !filters.get(property).matches(values)) {
          return false;
        }
      }
      return true;
    }

    public boolean matches(OnestoreEntity.Property prop) {
      FilterMatcher filter = filters.get(prop.getName());
      if (filter == null) {
        return true;
      }
      return filter.matches(
          Collections.singletonList(DataTypeTranslator.getComparablePropertyValue(prop)));
    }

    @Override
    @Nullable
    List> getComparablePropertyValues(
        OnestoreEntity.EntityProto entityProto, String propertyName) {
      Collection entityProperties =
          DataTypeTranslator.findIndexedPropertiesOnPb(entityProto, propertyName);
      if (entityProperties.isEmpty()) {
        return null;
      }
      if (propertyName.equals(Entity.KEY_RESERVED_PROPERTY) && !entityProto.hasKey()) {
        return null;
      }
      List> values = new ArrayList<>(entityProperties.size());
      for (OnestoreEntity.Property prop : entityProperties) {
        values.add(DataTypeTranslator.getComparablePropertyValue(prop));
      }
      return values;
    }
  }

  private EntityProtoComparators() {}
}