com.jcabi.dynamo.Conditions Maven / Gradle / Ivy
/*
* Copyright (c) 2012-2023, jcabi.com
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met: 1) Redistributions of source code must retain the above
* copyright notice, this list of conditions and the following
* disclaimer. 2) Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution. 3) Neither the name of the jcabi.com nor
* the names of its contributors may be used to endorse or promote
* products derived from this software without specific prior written
* permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
* NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.jcabi.dynamo;
import com.amazonaws.services.dynamodbv2.model.AttributeValue;
import com.amazonaws.services.dynamodbv2.model.ComparisonOperator;
import com.amazonaws.services.dynamodbv2.model.Condition;
import com.google.common.base.Joiner;
import com.jcabi.aspects.Immutable;
import com.jcabi.aspects.Loggable;
import com.jcabi.immutable.ArrayMap;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import lombok.EqualsAndHashCode;
/**
* DynamoDB query conditions.
*
* It's a convenient immutable builder of a map of conditions for
* DynamoDB query/scan operations. Use it like this:
*
*
Map<String, Condition> conditions = new Conditions()
* .with("hash", Conditions.equalTo("some value"))
* .with("range", Conditions.equalTo(12345));
*
*
* @since 0.1
*/
@Immutable
@Loggable(Loggable.DEBUG)
@EqualsAndHashCode(of = "conds")
@SuppressWarnings
(
{
"PMD.TooManyMethods",
"PMD.ProhibitPublicStaticMethods",
"PMD.AvoidInstantiatingObjectsInLoops"
}
)
public final class Conditions implements Map {
/**
* Pairs.
*/
private final transient ArrayMap conds;
/**
* Public ctor.
*/
public Conditions() {
this(new ArrayMap<>());
}
/**
* Public ctor.
* @param map Map of them
*/
public Conditions(final Map map) {
this.conds = Conditions.array(map);
}
/**
* Equal to static condition builder (factory method).
* @param value The value to equal to
* @return The condition just created
*/
public static Condition equalTo(final Long value) {
return Conditions.equalTo(
new AttributeValue().withN(value.toString())
);
}
/**
* Equal to static condition builder (factory method).
* @param value The value to equal to
* @return The condition just created
*/
public static Condition equalTo(final Integer value) {
return Conditions.equalTo(
new AttributeValue().withN(value.toString())
);
}
/**
* Equal to static condition builder (factory method).
* @param value The value to equal to
* @return The condition just created
*/
public static Condition equalTo(final Object value) {
return Conditions.equalTo(
new AttributeValue().withS(value.toString())
);
}
/**
* Equal to static condition builder (factory method).
* @param value The value to equal to
* @return The condition just created
*/
public static Condition equalTo(final AttributeValue value) {
return new Condition()
.withComparisonOperator(ComparisonOperator.EQ)
.withAttributeValueList(value);
}
/**
* With this condition.
* @param name Attribute name
* @param value The condition
* @return New map of conditions
*/
public Conditions with(final String name, final Condition value) {
return new Conditions(
this.conds.with(name, value)
);
}
/**
* With this condition.
* @param name Attribute name
* @param value The condition
* @return New map of conditions
* @since 0.18
*/
public Conditions with(final String name, final Object value) {
return new Conditions(
this.conds.with(
name,
Conditions.equalTo(value)
)
);
}
/**
* With these conditions.
* @param map The conditions
* @return New map of conditions
*/
public Conditions withAttributes(final Map map) {
final ConcurrentMap cnds =
new ConcurrentHashMap<>(map.size());
for (final Map.Entry entry : map.entrySet()) {
cnds.put(
entry.getKey(),
Conditions.equalTo(entry.getValue())
);
}
return new Conditions(this.conds.with(cnds));
}
/**
* With these conditions.
* @param map The conditions
* @return New map of conditions
*/
public Conditions with(final Map map) {
return new Conditions(this.conds.with(map));
}
@Override
public String toString() {
final Collection terms =
new ArrayList<>(this.conds.size());
for (final Map.Entry cond : this.conds.entrySet()) {
terms.add(
String.format(
"%s %s %s",
cond.getKey(),
cond.getValue().getComparisonOperator(),
cond.getValue().getAttributeValueList()
)
);
}
return Joiner.on(" AND ").join(terms);
}
@Override
public int size() {
return this.conds.size();
}
@Override
public boolean isEmpty() {
return this.conds.isEmpty();
}
@Override
public boolean containsKey(final Object key) {
return this.conds.containsKey(key.toString());
}
@Override
public boolean containsValue(final Object value) {
return this.conds.containsValue(value);
}
@Override
public Condition get(final Object key) {
return this.conds.get(key.toString());
}
@Override
public Set keySet() {
return this.conds.keySet();
}
@Override
public Collection values() {
return this.conds.values();
}
@Override
public Set> entrySet() {
return this.conds.entrySet();
}
@Override
public Condition put(final String key, final Condition value) {
throw new UnsupportedOperationException(
"Conditions class is immutable, can't do #put()"
);
}
@Override
public Condition remove(final Object key) {
throw new UnsupportedOperationException(
"Conditions class is immutable, can't do #remove()"
);
}
@Override
public void putAll(final Map map) {
throw new UnsupportedOperationException(
"Conditions class is immutable, can't do #putAll()"
);
}
@Override
public void clear() {
throw new UnsupportedOperationException(
"Conditions class is immutable, can't do #clear()"
);
}
/**
* Convert map to ArrayMap.
* @param map Map of them
* @return Array map
*/
private static ArrayMap array(
final Map map) {
final ConcurrentMap cnds =
new ConcurrentHashMap<>(map.size());
cnds.putAll(map);
return new ArrayMap<>(cnds);
}
}