From: Robert Varga Date: Fri, 29 Nov 2019 10:47:31 +0000 (+0100) Subject: Refactor ColumnType X-Git-Tag: release/magnesium~80 X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=commitdiff_plain;h=a8293448cde818eb893470991b9bc179e181dbce;p=ovsdb.git Refactor ColumnType This factors out the two known implementations, hiding them from public view in process. Parsing from JSON is factored out so that we do not have blank singletons just to hook parsing. Change-Id: I3dd7b110fb0ca3fe18ef879a2c3d24523fc43419 Signed-off-by: Robert Varga --- diff --git a/library/impl/src/main/java/org/opendaylight/ovsdb/lib/schema/AtomicColumnType.java b/library/impl/src/main/java/org/opendaylight/ovsdb/lib/schema/AtomicColumnType.java new file mode 100644 index 000000000..eb70b7006 --- /dev/null +++ b/library/impl/src/main/java/org/opendaylight/ovsdb/lib/schema/AtomicColumnType.java @@ -0,0 +1,58 @@ +/* + * Copyright (c) 2014, 2015 EBay Software Foundation and others. All rights reserved. + * + * This program and the accompanying materials are made available under the + * terms of the Eclipse Public License v1.0 which accompanies this distribution, + * and is available at http://www.eclipse.org/legal/epl-v10.html + */ +package org.opendaylight.ovsdb.lib.schema; + +import com.fasterxml.jackson.databind.JsonNode; +import org.opendaylight.ovsdb.lib.notation.OvsdbSet; + +final class AtomicColumnType extends ColumnType { + AtomicColumnType(final BaseType baseType) { + super(baseType, 1, 1); + } + + AtomicColumnType(final BaseType baseType, final long min, final long max) { + super(baseType, min, max); + } + + /** + * Creates a ColumnType from the JsonNode if the implementation knows how to, returns null otherwise. + * + * @param json the JSONNode object that needs to converted + * @return a valid SubType or Null (if the JsonNode does not represent the subtype) + */ + static AtomicColumnType fromJsonNode(final JsonNode json) { + if (json.isObject() && json.has("value")) { + return null; + } + BaseType jsonBaseType = BaseType.fromJson(json, "key"); + return jsonBaseType == null ? null : new AtomicColumnType(jsonBaseType, minFromJson(json), maxFromJson(json)); + } + + @Override + public Object valueFromJson(final JsonNode value) { + if (isMultiValued()) { + OvsdbSet result = new OvsdbSet<>(); + if (value.isArray()) { + if (value.size() == 2) { + if (value.get(0).isTextual() && "set".equals(value.get(0).asText())) { + for (JsonNode node: value.get(1)) { + result.add(getBaseType().toValue(node)); + } + } else { + result.add(getBaseType().toValue(value)); + } + } + } else { + result.add(getBaseType().toValue(value)); + } + return result; + } else { + return getBaseType().toValue(value); + } + } +} diff --git a/library/impl/src/main/java/org/opendaylight/ovsdb/lib/schema/ColumnType.java b/library/impl/src/main/java/org/opendaylight/ovsdb/lib/schema/ColumnType.java index 40b421d83..bf585b486 100644 --- a/library/impl/src/main/java/org/opendaylight/ovsdb/lib/schema/ColumnType.java +++ b/library/impl/src/main/java/org/opendaylight/ovsdb/lib/schema/ColumnType.java @@ -5,55 +5,28 @@ * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ - package org.opendaylight.ovsdb.lib.schema; import com.fasterxml.jackson.databind.JsonNode; +import com.google.common.collect.ImmutableList; +import java.util.function.Function; import org.opendaylight.ovsdb.lib.error.TyperException; import org.opendaylight.ovsdb.lib.jsonrpc.JsonUtils; -import org.opendaylight.ovsdb.lib.notation.OvsdbMap; -import org.opendaylight.ovsdb.lib.notation.OvsdbSet; - public abstract class ColumnType { - BaseType baseType; - long min = 1; - long max = 1; + private static final ImmutableList> FACTORIES = ImmutableList.of( + AtomicColumnType::fromJsonNode, KeyValuedColumnType::fromJsonNode); - public long getMin() { - return min; - } + private final BaseType baseType; + private final long min; + private final long max; - void setMin(long min) { + ColumnType(final BaseType baseType, final long min, final long max) { + this.baseType = baseType; this.min = min; - } - - public long getMax() { - return max; - } - - void setMax(long max) { this.max = max; } - private static ColumnType[] columns = new ColumnType[] { - new AtomicColumnType(), - new KeyValuedColumnType() - }; - - - public ColumnType() { - - } - - public ColumnType(BaseType baseType) { - this.baseType = baseType; - } - - public BaseType getBaseType() { - return baseType; - } - /** * JSON. * 
@@ -71,9 +44,9 @@ public abstract class ColumnType {
                  "max": "unlimited"
             }
*/ - public static ColumnType fromJson(JsonNode json) { - for (ColumnType colType : columns) { - ColumnType columnType = colType.fromJsonNode(json); + public static ColumnType fromJson(final JsonNode json) { + for (Function factory : FACTORIES) { + ColumnType columnType = factory.apply(json); if (null != columnType) { return columnType; } @@ -83,14 +56,17 @@ public abstract class ColumnType { JsonUtils.prettyString(json))); } + public BaseType getBaseType() { + return baseType; + } - /** - * Creates a ColumnType from the JsonNode if the implementation knows how to, returns null otherwise. - * - * @param json the JSONNode object that needs to converted - * @return a valid SubType or Null (if the JsonNode does not represent the subtype) - */ - protected abstract ColumnType fromJsonNode(JsonNode json); + public long getMin() { + return min; + } + + public long getMax() { + return max; + } /* * Per RFC 7047, Section 3.2 : @@ -108,7 +84,9 @@ public abstract class ColumnType { public abstract Object valueFromJson(JsonNode value); - public abstract void validate(Object value); + public void validate(final Object value) { + baseType.validate(value); + } @Override public String toString() { @@ -124,14 +102,14 @@ public abstract class ColumnType { final int prime = 31; int result = 1; result = prime * result - + ((baseType == null) ? 0 : baseType.hashCode()); - result = prime * result + (int) (max ^ (max >>> 32)); - result = prime * result + (int) (min ^ (min >>> 32)); + + (baseType == null ? 0 : baseType.hashCode()); + result = prime * result + (int) (max ^ max >>> 32); + result = prime * result + (int) (min ^ min >>> 32); return result; } @Override - public boolean equals(Object obj) { + public boolean equals(final Object obj) { if (this == obj) { return true; } @@ -158,174 +136,21 @@ public abstract class ColumnType { return true; } - public static class AtomicColumnType extends ColumnType { - public AtomicColumnType() { - } - - public AtomicColumnType(BaseType baseType) { - super(baseType); - } - - @Override - public AtomicColumnType fromJsonNode(JsonNode json) { - if (json.isObject() && json.has("value")) { - return null; - } - BaseType jsonBaseType = BaseType.fromJson(json, "key"); - - if (jsonBaseType != null) { - - AtomicColumnType atomicColumnType = new AtomicColumnType(jsonBaseType); - - JsonNode minNode = json.get("min"); - if (minNode != null) { - atomicColumnType.setMin(minNode.asLong()); - } - - JsonNode maxNode = json.get("max"); - if (maxNode != null) { - if (maxNode.isNumber()) { - atomicColumnType.setMax(maxNode.asLong()); - } else if ("unlimited".equals(maxNode.asText())) { - atomicColumnType.setMax(Long.MAX_VALUE); - } - } - return atomicColumnType; + static long maxFromJson(final JsonNode json) { + final JsonNode maxNode = json.get("max"); + if (maxNode != null) { + if (maxNode.isLong()) { + return maxNode.asLong(); } - - return null; - } - - @Override - public Object valueFromJson(JsonNode value) { - if (isMultiValued()) { - OvsdbSet result = new OvsdbSet<>(); - if (value.isArray()) { - if (value.size() == 2) { - if (value.get(0).isTextual() && "set".equals(value.get(0).asText())) { - for (JsonNode node: value.get(1)) { - result.add(getBaseType().toValue(node)); - } - } else { - result.add(getBaseType().toValue(value)); - } - } - } else { - result.add(getBaseType().toValue(value)); - } - return result; - } else { - return getBaseType().toValue(value); + if (maxNode.isTextual() && "unlimited".equals(maxNode.asText())) { + return Long.MAX_VALUE; } } - - @Override - public void validate(Object value) { - this.baseType.validate(value); - } - + return 1; } - public static class KeyValuedColumnType extends ColumnType { - BaseType keyType; - - public BaseType getKeyType() { - return keyType; - } - - public KeyValuedColumnType() { - } - - public KeyValuedColumnType(BaseType keyType, BaseType valueType) { - super(valueType); - this.keyType = keyType; - } - - @Override - public KeyValuedColumnType fromJsonNode(JsonNode json) { - if (json.isValueNode() || !json.has("value")) { - return null; - } - BaseType jsonKeyType = BaseType.fromJson(json, "key"); - BaseType valueType = BaseType.fromJson(json, "value"); - - KeyValuedColumnType keyValueColumnType = new KeyValuedColumnType(jsonKeyType, valueType); - JsonNode minNode = json.get("min"); - if (minNode != null) { - keyValueColumnType.setMin(minNode.asLong()); - } - - JsonNode maxNode = json.get("max"); - if (maxNode != null) { - if (maxNode.isLong()) { - keyValueColumnType.setMax(maxNode.asLong()); - } else if (maxNode.isTextual() && "unlimited".equals(maxNode.asText())) { - keyValueColumnType.setMax(Long.MAX_VALUE); - } - } - - return keyValueColumnType; - } - - @Override - public Object valueFromJson(JsonNode node) { - if (node.isArray() && node.size() == 2) { - if (node.get(0).isTextual() && "map".equals(node.get(0).asText())) { - OvsdbMap map = new OvsdbMap<>(); - for (JsonNode pairNode : node.get(1)) { - if (pairNode.isArray() && node.size() == 2) { - Object key = getKeyType().toValue(pairNode.get(0)); - Object value = getBaseType().toValue(pairNode.get(1)); - map.put(key, value); - } - } - return map; - } else if (node.size() == 0) { - return null; - } - } - return null; - } - - @Override - public void validate(Object value) { - this.baseType.validate(value); - } - - @Override - public String toString() { - return "KeyValuedColumnType [keyType=" + keyType + " " + super.toString() + "]"; - } - - @Override - public int hashCode() { - final int prime = 31; - int result = super.hashCode(); - result = prime * result - + ((keyType == null) ? 0 : keyType.hashCode()); - return result; - } - - @Override - public boolean equals(Object obj) { - if (this == obj) { - return true; - } - if (!super.equals(obj)) { - return false; - } - if (getClass() != obj.getClass()) { - return false; - } - KeyValuedColumnType other = (KeyValuedColumnType) obj; - if (keyType == null) { - if (other.keyType != null) { - return false; - } - } else if (!keyType.equals(other.keyType)) { - return false; - } - return true; - } + static long minFromJson(final JsonNode json) { + final JsonNode minNode = json.get("min"); + return minNode == null ? 1 : minNode.asLong(); } } diff --git a/library/impl/src/main/java/org/opendaylight/ovsdb/lib/schema/KeyValuedColumnType.java b/library/impl/src/main/java/org/opendaylight/ovsdb/lib/schema/KeyValuedColumnType.java new file mode 100644 index 000000000..a75d0fbd6 --- /dev/null +++ b/library/impl/src/main/java/org/opendaylight/ovsdb/lib/schema/KeyValuedColumnType.java @@ -0,0 +1,92 @@ +/* + * Copyright (c) 2014, 2015 EBay Software Foundation and others. All rights reserved. + * + * This program and the accompanying materials are made available under the + * terms of the Eclipse Public License v1.0 which accompanies this distribution, + * and is available at http://www.eclipse.org/legal/epl-v10.html + */ +package org.opendaylight.ovsdb.lib.schema; + +import com.fasterxml.jackson.databind.JsonNode; +import org.opendaylight.ovsdb.lib.notation.OvsdbMap; + +final class KeyValuedColumnType extends ColumnType { + private final BaseType keyType; + + private KeyValuedColumnType(final BaseType keyType, final BaseType valueType, final long min, final long max) { + super(valueType, min, max); + this.keyType = keyType; + } + + /** + * Creates a ColumnType from the JsonNode if the implementation knows how to, returns null otherwise. + * + * @param json the JSONNode object that needs to converted + * @return a valid SubType or Null (if the JsonNode does not represent the subtype) + */ + static KeyValuedColumnType fromJsonNode(final JsonNode json) { + if (json.isValueNode() || !json.has("value")) { + return null; + } + BaseType jsonKeyType = BaseType.fromJson(json, "key"); + BaseType valueType = BaseType.fromJson(json, "value"); + + return new KeyValuedColumnType(jsonKeyType, valueType, minFromJson(json), maxFromJson(json)); + } + + @Override + public Object valueFromJson(final JsonNode node) { + if (node.isArray() && node.size() == 2) { + if (node.get(0).isTextual() && "map".equals(node.get(0).asText())) { + OvsdbMap map = new OvsdbMap<>(); + for (JsonNode pairNode : node.get(1)) { + if (pairNode.isArray() && node.size() == 2) { + Object key = keyType.toValue(pairNode.get(0)); + Object value = getBaseType().toValue(pairNode.get(1)); + map.put(key, value); + } + } + return map; + } else if (node.size() == 0) { + return null; + } + } + return null; + } + + @Override + public String toString() { + return "KeyValuedColumnType [keyType=" + keyType + " " + super.toString() + "]"; + } + + @Override + public int hashCode() { + final int prime = 31; + int result = super.hashCode(); + result = prime * result + + (keyType == null ? 0 : keyType.hashCode()); + return result; + } + + @Override + public boolean equals(final Object obj) { + if (this == obj) { + return true; + } + if (!super.equals(obj)) { + return false; + } + if (getClass() != obj.getClass()) { + return false; + } + KeyValuedColumnType other = (KeyValuedColumnType) obj; + if (keyType == null) { + if (other.keyType != null) { + return false; + } + } else if (!keyType.equals(other.keyType)) { + return false; + } + return true; + } +} \ No newline at end of file diff --git a/library/impl/src/main/java/org/opendaylight/ovsdb/lib/schema/TableSchema.java b/library/impl/src/main/java/org/opendaylight/ovsdb/lib/schema/TableSchema.java index a41fbe31a..c2831c5c2 100644 --- a/library/impl/src/main/java/org/opendaylight/ovsdb/lib/schema/TableSchema.java +++ b/library/impl/src/main/java/org/opendaylight/ovsdb/lib/schema/TableSchema.java @@ -23,7 +23,6 @@ import org.opendaylight.ovsdb.lib.notation.Row; import org.opendaylight.ovsdb.lib.notation.UUID; import org.opendaylight.ovsdb.lib.operations.Insert; import org.opendaylight.ovsdb.lib.schema.BaseType.UuidBaseType; -import org.opendaylight.ovsdb.lib.schema.ColumnType.AtomicColumnType; public abstract class TableSchema> {