Skip to content

Add configurable boolean encoding #168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Add configurable boolean encoding #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
193da6b
add configurable boolean encoding
cinterloper Nov 7, 2024
48743f8
change option name from Object to Boolean
cinterloper Nov 7, 2024
f3582f0
set UseBoolBin instead of casting, fix test case to default to Long
cinterloper Nov 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 20 additions & 3 deletions src/main/java/com/aerospike/mapper/tools/configuration/ClassConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import com.aerospike.mapper.annotations.AerospikeEmbed;
import com.aerospike.mapper.annotations.AerospikeReference;
import com.aerospike.mapper.tools.ConfigurationUtils;
import com.aerospike.mapper.tools.mappers.BooleanMapper;
import com.fasterxml.jackson.annotation.JsonProperty;

public class ClassConfig {
Expand All @@ -26,11 +27,17 @@ public class ClassConfig {
private String factoryClass;
private String factoryMethod;
private final List<BinConfig> bins;
private BooleanMapper.Encoding boolEncoding = BooleanMapper.Encoding.Numeric;


public ClassConfig() {
bins = new ArrayList<>();
}

public BooleanMapper.Encoding getBoolEncoding() {
return boolEncoding;
}

public String getClassName() {
return className;
}
Expand Down Expand Up @@ -163,16 +170,21 @@ private void setKey(KeyConfig key) {
private void setShortName(String shortName) {
this.shortName = shortName;
}


private void setBoolEncoding( BooleanMapper.Encoding boolEncoding) {
this.boolEncoding = boolEncoding;
}

public static class Builder {
private final Class<?> clazz;
private final ClassConfig classConfig;

public Builder(final Class<?> clazz) {
this.clazz = clazz;
this.classConfig = new ClassConfig();
this.classConfig.setClassName(clazz.getName());
}

private void validateFieldExists(String fieldName) {
if (!ConfigurationUtils.validateFieldOnClass(this.clazz, fieldName)) {
throw new AerospikeException(String.format("Field %s does not exist on class %s or its superclasses", fieldName, this.clazz));
Expand All @@ -199,6 +211,11 @@ public Builder withTtl(int ttl) {
return this;
}

public Builder withBoolEncoding(BooleanMapper.Encoding boolEncoding) {
this.classConfig.setBoolEncoding(boolEncoding);
return this;
}

public Builder withVersion(int version) {
this.classConfig.setVersion(version);
return this;
Expand All @@ -223,7 +240,7 @@ public Builder withShortName(boolean sendKey) {
this.classConfig.setSendKey(sendKey);
return this;
}

public Builder withFactoryClassAndMethod(@NotNull Class<?> factoryClass, @NotNull String factoryMethod) {
this.classConfig.setFactoryClass(factoryClass.getName());
this.classConfig.setFactoryMethod(factoryMethod);
Expand Down
24 changes: 24 additions & 0 deletions src/main/java/com/aerospike/mapper/tools/mappers/BooleanMapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,37 @@
package com.aerospike.mapper.tools.mappers;

import com.aerospike.mapper.tools.ClassCache;
import com.aerospike.mapper.tools.TypeMapper;
import com.aerospike.mapper.tools.configuration.ClassConfig;

import static com.aerospike.client.Value.UseBoolBin;

public class BooleanMapper extends TypeMapper {

public enum Encoding {
Numeric,
Boolean
}

private final ClassConfig classConfig;

public BooleanMapper(final ClassConfig config) {
super();
classConfig = config;
}

@Override
public Object toAerospikeFormat(Object value) {
if (ClassCache.getInstance().hasClassConfig(Boolean.class)) {
UseBoolBin = ClassCache.getInstance()
.getClassConfig(Boolean.class)
.getBoolEncoding()
.equals(Encoding.Boolean);
} else {
UseBoolBin = false;
}


if (value == null) {
return null;
}
Expand Down
3 changes: 2 additions & 1 deletion src/main/java/com/aerospike/mapper/tools/utils/TypeUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,8 @@ private static TypeMapper getMapper(Class<?> clazz, AnnotatedType type, IBaseAer
} else if (Integer.class.isAssignableFrom(clazz) || Integer.TYPE.isAssignableFrom(clazz)) {
typeMapper = new IntMapper();
} else if (Boolean.class.isAssignableFrom(clazz) || Boolean.TYPE.isAssignableFrom(clazz)) {
typeMapper = new BooleanMapper();
ClassConfig config = ClassCache.getInstance().getClassConfig(clazz);
typeMapper = new BooleanMapper(config);
} else if (Float.class.isAssignableFrom(clazz) || Float.TYPE.isAssignableFrom(clazz)) {
typeMapper = new FloatMapper();
} else if (clazz.isEnum()) {
Expand Down
104 changes: 104 additions & 0 deletions src/test/java/com/aerospike/mapper/BooleanTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
package com.aerospike.mapper;

import com.aerospike.client.Key;
import com.aerospike.client.Record;
import com.aerospike.client.policy.Policy;
import com.aerospike.mapper.annotations.AerospikeKey;
import com.aerospike.mapper.annotations.AerospikeRecord;
import com.aerospike.mapper.tools.AeroMapper;
import com.fasterxml.jackson.core.JsonProcessingException;
import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.assertEquals;

public class BooleanTest extends AeroMapperBaseTest {
@AerospikeRecord(namespace = "test", set = "B")
public static class B {
@AerospikeKey
public int id;
public Boolean boolValue;
}

@Test
public void testNumericEncoding() throws JsonProcessingException {
B b = new B();
b.boolValue = true;
b.id = 1;
String config =
"---\n" +
"classes:\n" +
" - class: com.aerospike.mapper.BooleanTest$B\n" +
" namespace: test\n" +
" set: B\n" +
" key:\n" +
" field: id\n" +
" - class: java.lang.Boolean\n" +
" boolEncoding: Numeric\n";

AeroMapper mapper = new AeroMapper.Builder(client).withConfiguration(config).build();
mapper.save(b);

B b2 = mapper.read(B.class, 1);

assertEquals(b.id, b2.id);
assertEquals(b.boolValue, b2.boolValue);
final Record rec = mapper.getClient().get(new Policy(), new Key("test", "B", 1));
final Object rawRepresentation = rec.bins.get("boolValue");
assertEquals(Long.class, rawRepresentation.getClass());
}

@Test
public void testObjectEncoding() throws JsonProcessingException {
B b = new B();
b.boolValue = true;
b.id = 1;
String config =
"---\n" +
"classes:\n" +
" - class: com.aerospike.mapper.BooleanTest$B\n" +
" namespace: test\n" +
" set: B\n" +
" key:\n" +
" field: id\n" +
" - class: java.lang.Boolean\n" +
" boolEncoding: Boolean\n";

AeroMapper mapper = new AeroMapper.Builder(client).withConfiguration(config).build();
mapper.save(b);

B b2 = mapper.read(B.class, 1);

assertEquals(b.id, b2.id);
assertEquals(b.boolValue, b2.boolValue);
final Record rec = mapper.getClient().get(new Policy(), new Key("test", "B", 1));
final Object rawRepresentation = rec.bins.get("boolValue");
assertEquals(Boolean.class, rawRepresentation.getClass());
}

@Test
public void testNumericByDefault() throws JsonProcessingException {
B b = new B();
b.boolValue = true;
b.id = 1;
String config =
"---\n" +
"classes:\n" +
" - class: com.aerospike.mapper.BooleanTest$B\n" +
" namespace: test\n" +
" set: B\n" +
" key:\n" +
" field: id\n";

AeroMapper mapper = new AeroMapper.Builder(client).withConfiguration(config).build();
mapper.save(b);

B b2 = mapper.read(B.class, 1);

assertEquals(b.id, b2.id);
assertEquals(b.boolValue, b2.boolValue);
final Record rec = mapper.getClient().get(new Policy(), new Key("test", "B", 1));
final Object rawRepresentation = rec.bins.get("boolValue");
assertEquals(Long.class, rawRepresentation.getClass());
}

}
2 changes: 1 addition & 1 deletion src/test/java/com/aerospike/mapper/DefaultFieldValuesTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ public void testBooleanValue() {
UseBoolBin = true;
mapper.save(obj);
record = client.get(null, key);
assertTrue(record.bins.get("bool2") instanceof Boolean);
assertTrue(record.bins.get("bool2") instanceof Long);
assertFalse(record.getBoolean("bool2"));
dfc = mapper.read(DefaultFieldsClass.class, "dfc");
assertFalse(dfc.bool2);
Expand Down
Loading