All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • com.google.cloud.firestore.DocumentTransform Maven / Gradle / Ivy

    There is a newer version: 3.29.1
    Show newest version
    /*
 * Copyright 2017 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.cloud.firestore;

import com.google.firestore.v1.DocumentTransform.FieldTransform;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.SortedMap;
import java.util.TreeMap;

/**
 * A DocumentTransform contains pending server-side transforms and their corresponding field paths.
 */
final class DocumentTransform {

  private final SortedMap transforms; // Sorted for testing.

  private DocumentTransform(SortedMap transforms) {
    this.transforms = transforms;
  }

  static DocumentTransform fromFieldPathMap(Map values) {
    SortedMap transforms = new TreeMap<>();

    for (Map.Entry entry : values.entrySet()) {
      FieldPath path = entry.getKey();
      Object value = entry.getValue();
      if (value instanceof FieldValue) {
        FieldValue fieldValue = (FieldValue) value;
        if (fieldValue.includeInDocumentTransform()) {
          transforms.put(path, fieldValue.toProto(path));
        }
      } else if (value instanceof Map) {
        transforms.putAll(
            extractFromMap((Map) value, path, /* allowTransforms= */ true));
      } else if (entry.getValue() instanceof List) {
        // DocumentTransforms cannot be contained in Lists. We still process the List for
        // validation.
        validateArray((List) entry.getValue(), path);
      }
    }

    return new DocumentTransform(transforms);
  }

  private static SortedMap extractFromMap(
      Map values, FieldPath path, boolean allowTransforms) {
    SortedMap transforms = new TreeMap<>();

    for (Map.Entry entry : values.entrySet()) {
      Object value = entry.getValue();
      path = path.append(FieldPath.of(entry.getKey()));
      if (value instanceof FieldValue) {
        FieldValue fieldValue = (FieldValue) value;
        if (allowTransforms) {
          if (fieldValue.includeInDocumentTransform()) {
            transforms.put(path, fieldValue.toProto(path));
          }
        } else {
          throw FirestoreException.forInvalidArgument(
              fieldValue.getMethodName() + " is not supported inside of an array.");
        }
      } else if (value instanceof Map) {
        transforms.putAll(extractFromMap((Map) value, path, allowTransforms));
      } else if (entry.getValue() instanceof List) {
        validateArray((List) entry.getValue(), path);
      }
      path = path.getParent();
    }

    return transforms;
  }

  private static void validateArray(List values, FieldPath path) {
    for (int i = 0; i < values.size(); ++i) {
      Object value = values.get(i);
      path = path.append(FieldPath.of(Integer.toString(i)));
      if (value instanceof FieldValue) {
        throw FirestoreException.forInvalidArgument(
            ((FieldValue) value).getMethodName() + " is not supported inside of an array.");
      } else if (value instanceof Map) {
        extractFromMap((Map) value, path, false);
      } else if (value instanceof List) {
        validateArray((List) value, path);
      }
      path = path.getParent();
    }
  }

  boolean isEmpty() {
    return transforms.isEmpty();
  }

  Set getFields() {
    return Collections.unmodifiableSet(transforms.keySet());
  }

  Collection toPb() {
    return transforms.values();
  }
}
    
    
    
    

    




    
    
    © 2015 - 2024 Weber Informatics LLC | Privacy Policy