com.google.cloud.datastore.BaseEntity Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-cloud-datastore Show documentation
Show all versions of google-cloud-datastore Show documentation
Java idiomatic client for Google Cloud Datastore.
/*
* Copyright 2015 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.datastore;
import static com.google.cloud.datastore.BlobValue.of;
import static com.google.cloud.datastore.BooleanValue.of;
import static com.google.cloud.datastore.DoubleValue.of;
import static com.google.cloud.datastore.EntityValue.of;
import static com.google.cloud.datastore.KeyValue.of;
import static com.google.cloud.datastore.LatLngValue.of;
import static com.google.cloud.datastore.ListValue.of;
import static com.google.cloud.datastore.LongValue.of;
import static com.google.cloud.datastore.NullValue.of;
import static com.google.cloud.datastore.StringValue.of;
import static com.google.cloud.datastore.TimestampValue.of;
import com.google.cloud.Timestamp;
import com.google.common.base.MoreObjects;
import com.google.common.collect.ImmutableSortedMap;
import com.google.common.collect.Maps;
import java.io.Serializable;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
/**
* A base class for entities (key and properties). An entity is a Google Cloud Datastore persistent
* data object. An entity holds one or more properties, represented by a name (as {@link String})
* and a value (as {@link com.google.cloud.datastore.Value}), and may be associated with a key. For
* a list of possible values see {@link ValueType}.
*
* @see Google Cloud Datastore
* Entities, Properties, and Keys
*/
public abstract class BaseEntity implements Serializable {
private static final long serialVersionUID = -9070588108769487081L;
private final ImmutableSortedMap> properties;
private final K key;
public abstract static class Builder> {
private K key;
private final Map> properties = new HashMap<>();
Builder() {}
Builder(K key) {
setKey(key);
}
Builder(BaseEntity entity) {
this(entity.key, entity);
}
Builder(K key, BaseEntity entity) {
setKey(key);
setProperties(entity.properties);
}
protected K key() {
return key;
}
protected Map> setProperties() {
return properties;
}
@SuppressWarnings("unchecked")
private B self() {
return (B) this;
}
@SuppressWarnings("unchecked")
B fill(com.google.datastore.v1.Entity entityPb) {
Map> copiedProperties = Maps.newHashMap();
for (Map.Entry entry :
entityPb.getPropertiesMap().entrySet()) {
copiedProperties.put(entry.getKey(), Value.fromPb(entry.getValue()));
}
setProperties(copiedProperties);
if (entityPb.hasKey()) {
setKey((K) IncompleteKey.fromPb(entityPb.getKey()));
}
return self();
}
protected B setProperties(Map> properties) {
this.properties.putAll(properties);
return self();
}
/** Sets the key for the entity. */
public B setKey(K key) {
this.key = key;
return self();
}
/** Clears all the properties. */
public B clear() {
properties.clear();
return self();
}
/** Removes a property with the given {@code name}. */
public B remove(String name) {
properties.remove(name);
return self();
}
/**
* Sets a property.
*
* @param name name of the property
* @param value value associated with the property
*/
public B set(String name, Value value) {
properties.put(name, value);
return self();
}
/**
* Sets a property of type {@link StringValue}.
*
* @param name name of the property
* @param value value associated with the property
*/
public B set(String name, String value) {
properties.put(name, of(value));
return self();
}
/**
* Sets a list property containing elements of type {@link StringValue}.
*
* @param name name of the property
* @param first the first string in the list
* @param second the second string in the list
* @param others other strings in the list
*/
public B set(String name, String first, String second, String... others) {
List values = new LinkedList<>();
values.add(of(first));
values.add(of(second));
for (String other : others) {
values.add(of(other));
}
properties.put(name, of(values));
return self();
}
/**
* Sets a property of type {@link LongValue}.
*
* @param name name of the property
* @param value value associated with the property
*/
public B set(String name, long value) {
properties.put(name, of(value));
return self();
}
/**
* Sets a list property containing elements of type {@link LongValue}.
*
* @param name name of the property
* @param first the first long in the list
* @param second the second long in the list
* @param others other longs in the list
*/
public B set(String name, long first, long second, long... others) {
List values = new LinkedList<>();
values.add(of(first));
values.add(of(second));
for (long other : others) {
values.add(of(other));
}
properties.put(name, of(values));
return self();
}
/**
* Sets a property of type {@link DoubleValue}.
*
* @param name name of the property
* @param value value associated with the property
*/
public B set(String name, double value) {
properties.put(name, of(value));
return self();
}
/**
* Sets a list property containing elements of type {@link DoubleValue}.
*
* @param name name of the property
* @param first the first double in the list
* @param second the second double in the list
* @param others other doubles in the list
*/
public B set(String name, double first, double second, double... others) {
List values = new LinkedList<>();
values.add(of(first));
values.add(of(second));
for (double other : others) {
values.add(of(other));
}
properties.put(name, of(values));
return self();
}
/**
* Sets a property of type {@link BooleanValue}.
*
* @param name name of the property
* @param value value associated with the property
*/
public B set(String name, boolean value) {
properties.put(name, of(value));
return self();
}
/**
* Sets a list property containing elements of type {@link BooleanValue}.
*
* @param name name of the property
* @param first the first boolean in the list
* @param second the second boolean in the list
* @param others other booleans in the list
*/
public B set(String name, boolean first, boolean second, boolean... others) {
List values = new LinkedList<>();
values.add(of(first));
values.add(of(second));
for (boolean other : others) {
values.add(of(other));
}
properties.put(name, of(values));
return self();
}
/**
* Sets a property of type {@link TimestampValue}.
*
* @param name name of the property
* @param value value associated with the property
*/
public B set(String name, Timestamp value) {
properties.put(name, of(value));
return self();
}
/**
* Sets a list property containing elements of type {@link TimestampValue}.
*
* @param name name of the property
* @param first the first {@link Timestamp} in the list
* @param second the second {@link Timestamp} in the list
* @param others other {@link Timestamp}s in the list
*/
public B set(String name, Timestamp first, Timestamp second, Timestamp... others) {
List values = new LinkedList<>();
values.add(of(first));
values.add(of(second));
for (Timestamp other : others) {
values.add(of(other));
}
properties.put(name, of(values));
return self();
}
/**
* Sets a property of type {@link LatLng}.
*
* @param name name of the property
* @param value value associated with the property
*/
public B set(String name, LatLng value) {
properties.put(name, of(value));
return self();
}
/**
* Sets a list property containing elements of type {@link LatLng}.
*
* @param name name of the property
* @param first the first {@link LatLng} in the list
* @param second the second {@link LatLng} in the list
* @param others other {@link LatLng}s in the list
*/
public B set(String name, LatLng first, LatLng second, LatLng... others) {
List values = new LinkedList<>();
values.add(of(first));
values.add(of(second));
for (LatLng other : others) {
values.add(of(other));
}
properties.put(name, of(values));
return self();
}
/**
* Sets a property of type {@link KeyValue}.
*
* @param name name of the property
* @param value value associated with the property
*/
public B set(String name, Key value) {
properties.put(name, of(value));
return self();
}
/**
* Sets a list property containing elements of type {@link KeyValue}.
*
* @param name name of the property
* @param first the first {@link Key} in the list
* @param second the second {@link Key} in the list
* @param others other {@link Key}s in the list
*/
public B set(String name, Key first, Key second, Key... others) {
List values = new LinkedList<>();
values.add(of(first));
values.add(of(second));
for (Key other : others) {
values.add(of(other));
}
properties.put(name, of(values));
return self();
}
/**
* Sets a property of type {@link EntityValue}.
*
* @param name name of the property
* @param value value associated with the property
*/
public B set(String name, FullEntity value) {
properties.put(name, of(value));
return self();
}
/**
* Sets a list property containing elements of type {@link EntityValue}.
*
* @param name name of the property
* @param first the first {@link FullEntity} in the list
* @param second the second {@link FullEntity} in the list
* @param others other entities in the list
*/
public B set(String name, FullEntity first, FullEntity second, FullEntity... others) {
List values = new LinkedList<>();
values.add(of(first));
values.add(of(second));
for (FullEntity other : others) {
values.add(of(other));
}
properties.put(name, of(values));
return self();
}
/**
* Sets a property of type {@link ListValue}.
*
* @param name name of the property
* @param values list of values associated with the property
*/
public B set(String name, List> values) {
properties.put(name, of(values));
return self();
}
/**
* Sets a property of type {@link ListValue}.
*
* @param name name of the property
* @param first the first value in the list
* @param second the second value in the list
* @param others other values in the list
*/
public B set(String name, Value first, Value second, Value... others) {
properties.put(name, ListValue.newBuilder().addValue(first).addValue(second, others).build());
return self();
}
/**
* Sets a property of type {@link BlobValue}.
*
* @param name name of the property
* @param value value associated with the property
*/
public B set(String name, Blob value) {
properties.put(name, of(value));
return self();
}
/**
* Sets a list property containing elements of type {@link BlobValue}.
*
* @param name name of the property
* @param first the first {@link Blob} in the list
* @param second the second {@link Blob} in the list
* @param others other {@link Blob}s in the list
*/
public B set(String name, Blob first, Blob second, Blob... others) {
List values = new LinkedList<>();
values.add(of(first));
values.add(of(second));
for (Blob other : others) {
values.add(of(other));
}
properties.put(name, of(values));
return self();
}
/**
* Sets a property of type {@code NullValue}.
*
* @param name name of the property
*/
public B setNull(String name) {
properties.put(name, of());
return self();
}
public abstract BaseEntity build();
}
BaseEntity(Builder builder) {
this.key = builder.key;
this.properties = ImmutableSortedMap.copyOf(builder.properties);
}
BaseEntity(BaseEntity from) {
this.key = from.getKey();
this.properties = from.properties;
}
@Override
public String toString() {
return MoreObjects.toStringHelper(this)
.add("key", key)
.add("properties", properties)
.toString();
}
@Override
public int hashCode() {
return Objects.hash(key, properties);
}
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof BaseEntity)) {
return false;
}
BaseEntity other = (BaseEntity) obj;
return Objects.equals(key, other.key) && Objects.equals(properties, other.properties);
}
/** Returns true if entity has a non-null key. */
public boolean hasKey() {
return key != null;
}
/** Returns the associated key or null if it does not have one. */
public K getKey() {
return key;
}
/** Returns {@code true} if the entity contains a property with the given {@code name}. */
public boolean contains(String name) {
return properties.containsKey(name);
}
/**
* Returns the {@link Value} for the given property {@code name}.
*
* @throws DatastoreException if no such property
*/
public > V getValue(String name) {
@SuppressWarnings("unchecked")
V property = (V) properties.get(name);
if (property == null) {
throw DatastoreException.throwInvalidRequest("No such property %s", name);
}
return property;
}
/**
* Returns true if property is an instance of NullValue.
*
* @throws DatastoreException if no such property
*/
public boolean isNull(String name) {
return getValue(name) instanceof NullValue;
}
/**
* Returns the property value as a string.
*
* @throws DatastoreException if no such property
* @throws ClassCastException if value is not a string
*/
@SuppressWarnings("unchecked")
public String getString(String name) {
return ((Value) getValue(name)).get();
}
/**
* Returns the property value as long.
*
* @throws DatastoreException if no such property
* @throws ClassCastException if value is not a long
*/
@SuppressWarnings("unchecked")
public long getLong(String name) {
return ((Value) getValue(name)).get();
}
/**
* Returns the property value as a double.
*
* @throws DatastoreException if no such property
* @throws ClassCastException if value is not a double
*/
@SuppressWarnings("unchecked")
public double getDouble(String name) {
return ((Value) getValue(name)).get();
}
/**
* Returns the property value as a boolean.
*
* @throws DatastoreException if no such property
* @throws ClassCastException if value is not a boolean
*/
@SuppressWarnings("unchecked")
public boolean getBoolean(String name) {
return ((Value) getValue(name)).get();
}
/**
* Returns the property value as a Timestamp.
*
* @throws DatastoreException if no such property
* @throws ClassCastException if value is not a Timestamp
*/
@SuppressWarnings("unchecked")
public Timestamp getTimestamp(String name) {
return ((Value) getValue(name)).get();
}
/**
* Returns the property value as a LatLng.
*
* @throws DatastoreException if no such property.
* @throws ClassCastException if value is not a LatLng.
*/
@SuppressWarnings("unchecked")
public LatLng getLatLng(String name) {
return ((Value) getValue(name)).get();
}
/**
* Returns the property value as a Key.
*
* @throws DatastoreException if no such property
* @throws ClassCastException if value is not a Key
*/
@SuppressWarnings("unchecked")
public Key getKey(String name) {
return ((Value) getValue(name)).get();
}
/**
* Returns the property value as an entity.
*
* @throws DatastoreException if no such property
* @throws ClassCastException if value is not an entity
*/
@SuppressWarnings("unchecked")
public FullEntity getEntity(String name) {
return ((Value>) getValue(name)).get();
}
/**
* Returns the property value as a list of values.
*
* @throws DatastoreException if no such property
* @throws ClassCastException if value is not a list of values
*/
@SuppressWarnings("unchecked")
public > List getList(String name) {
return (List) getValue(name).get();
}
/**
* Returns the property value as a blob.
*
* @throws DatastoreException if no such property
* @throws ClassCastException if value is not a blob
*/
@SuppressWarnings("unchecked")
public Blob getBlob(String name) {
return ((Value) getValue(name)).get();
}
/** Returns the properties name. */
public Set getNames() {
return properties.keySet();
}
/** Returns the properties. */
public Map> getProperties() {
return properties;
}
final com.google.datastore.v1.Entity toPb() {
com.google.datastore.v1.Entity.Builder entityPb = com.google.datastore.v1.Entity.newBuilder();
for (Map.Entry> entry : properties.entrySet()) {
entityPb.putProperties(entry.getKey(), entry.getValue().toPb());
}
if (key != null) {
entityPb.setKey(key.toPb());
}
return entityPb.build();
}
}