From 87be30582d1db37bee7c6b456c0c5c3ca9584963 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Tue, 4 Sep 2018 17:24:15 +0100 Subject: Fix checkstyle issues in apex model basic CHeckstyle issues in apex model basic and knock on changes in other apex modules. Issue-ID: POLICY-1034 Change-Id: I65823f5e2e344526abc74b0812877113acb056ec Signed-off-by: liamfallon --- .../basicmodel/concepts/ApexConceptException.java | 6 +- .../model/basicmodel/concepts/ApexException.java | 15 +-- .../basicmodel/concepts/ApexRuntimeException.java | 12 +- .../model/basicmodel/concepts/AxArtifactKey.java | 33 ++--- .../apex/model/basicmodel/concepts/AxConcept.java | 12 +- .../model/basicmodel/concepts/AxConceptGetter.java | 6 +- .../basicmodel/concepts/AxConceptGetterImpl.java | 6 +- .../apex/model/basicmodel/concepts/AxKey.java | 6 +- .../apex/model/basicmodel/concepts/AxKeyInfo.java | 30 ++--- .../basicmodel/concepts/AxKeyInformation.java | 22 +-- .../apex/model/basicmodel/concepts/AxKeyUse.java | 10 +- .../apex/model/basicmodel/concepts/AxModel.java | 56 ++++---- .../model/basicmodel/concepts/AxReferenceKey.java | 25 ++-- .../basicmodel/concepts/AxValidationResult.java | 2 +- .../policy/apex/model/basicmodel/dao/ApexDao.java | 58 ++++---- .../apex/model/basicmodel/dao/ApexDaoFactory.java | 4 +- .../apex/model/basicmodel/dao/DAOParameters.java | 125 ----------------- .../apex/model/basicmodel/dao/DaoParameters.java | 125 +++++++++++++++++ .../dao/converters/CDATAConditioner.java | 91 ------------- .../dao/converters/CDataConditioner.java | 91 +++++++++++++ .../basicmodel/dao/converters/UUID2String.java | 83 ------------ .../basicmodel/dao/converters/Uuid2String.java | 83 ++++++++++++ .../model/basicmodel/dao/impl/DefaultApexDao.java | 124 ++++++++--------- .../model/basicmodel/dao/impl/package-info.java | 3 +- .../apex/model/basicmodel/dao/package-info.java | 4 +- .../basicmodel/handling/ApexModelCreator.java | 3 +- .../basicmodel/handling/ApexModelException.java | 6 +- .../basicmodel/handling/ApexModelFileWriter.java | 14 +- .../model/basicmodel/handling/ApexModelReader.java | 11 +- .../model/basicmodel/handling/ApexModelSaver.java | 16 +-- .../basicmodel/handling/ApexModelStringWriter.java | 20 ++- .../model/basicmodel/handling/ApexModelWriter.java | 16 +-- .../basicmodel/handling/ApexSchemaGenerator.java | 38 +++--- .../policy/apex/model/basicmodel/package-info.java | 7 +- .../model/basicmodel/service/ModelService.java | 13 +- .../apex/model/basicmodel/test/TestApexModel.java | 71 +++++----- .../basicmodel/test/TestApexModelCreator.java | 4 +- .../apex/model/basicmodel/concepts/AxKeyTest.java | 150 +++++++++++---------- .../model/basicmodel/concepts/TestAxKeyInfo.java | 38 +++--- .../basicmodel/concepts/TestAxReferenceKey.java | 40 +++--- .../apex/model/basicmodel/concepts/TestEntity.java | 63 +++++---- .../model/basicmodel/concepts/TestExceptions.java | 30 ++--- .../apex/model/basicmodel/concepts/TestKeyUse.java | 82 +++++++++++ .../model/basicmodel/concepts/TestValidation.java | 53 ++++---- .../apex/model/basicmodel/concepts/testKeyUse.java | 82 ----------- .../apex/model/basicmodel/dao/EntityTest.java | 42 +++--- .../apex/model/basicmodel/dao/TestDaoMisc.java | 27 ++-- .../basicmodel/handling/AxModelWithReferences.java | 25 ++-- .../basicmodel/handling/TestApexBasicModel.java | 66 +++++---- .../handling/TestApexBasicModelConcepts.java | 12 +- .../handling/TestApexBasicModelCreator.java | 42 +++--- .../handling/TestApexTestModelCreator0.java | 3 +- .../handling/TestApexTestModelCreator1.java | 14 +- .../handling/TestApexTestModelCreator2.java | 3 +- .../basicmodel/handling/TestBasicModelTest.java | 33 +++-- .../basicmodel/handling/TestConceptGetter.java | 139 +++++++++++-------- .../model/basicmodel/handling/TestExceptions.java | 3 - .../basicmodel/handling/TestModelFileWriter.java | 22 ++- .../model/basicmodel/handling/TestModelReader.java | 13 +- .../model/basicmodel/handling/TestModelSaver.java | 18 ++- .../basicmodel/handling/TestModelStringWriter.java | 27 ++-- .../model/basicmodel/handling/TestModelWriter.java | 7 +- .../basicmodel/handling/TestSchemaGenerator.java | 5 +- .../model/basicmodel/service/TestModelService.java | 22 ++- .../basicmodel/xml/TestAxReferenceKeyAdapter.java | 11 +- .../src/test/resources/META-INF/persistence.xml | 6 +- 66 files changed, 1172 insertions(+), 1157 deletions(-) delete mode 100644 model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/DAOParameters.java create mode 100644 model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/DaoParameters.java delete mode 100644 model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/converters/CDATAConditioner.java create mode 100644 model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/converters/CDataConditioner.java delete mode 100644 model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/converters/UUID2String.java create mode 100644 model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/converters/Uuid2String.java create mode 100644 model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/TestKeyUse.java delete mode 100644 model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/testKeyUse.java (limited to 'model/basic-model') diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/ApexConceptException.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/ApexConceptException.java index 1ffb2776c..d62818dc8 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/ApexConceptException.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/ApexConceptException.java @@ -41,9 +41,9 @@ public class ApexConceptException extends ApexException { * Instantiates a new apex concept exception. * * @param message the message on the exception - * @param e the exception that caused this Apex exception + * @param exception the exception that caused this Apex exception */ - public ApexConceptException(final String message, final Exception e) { - super(message, e); + public ApexConceptException(final String message, final Exception exception) { + super(message, exception); } } diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/ApexException.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/ApexException.java index 94472d3eb..97920c3b5 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/ApexException.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/ApexException.java @@ -55,21 +55,21 @@ public class ApexException extends Exception { * Instantiates a new apex exception. * * @param message the message on the exception - * @param e the exception that caused this Apex exception + * @param exception the exception that caused this Apex exception */ - public ApexException(final String message, final Exception e) { - this(message, e, null); + public ApexException(final String message, final Exception exception) { + this(message, exception, null); } /** * Instantiates a new apex exception. * * @param message the message on the exception - * @param e the exception that caused this Apex exception + * @param exception the exception that caused this Apex exception * @param object the object that the exception was thrown on */ - public ApexException(final String message, final Exception e, final Object object) { - super(message, e); + public ApexException(final String message, final Exception exception, final Object object) { + super(message, exception); this.object = object; } @@ -83,7 +83,7 @@ public class ApexException extends Exception { } /** - * Build a cascaded message from an exception and all its nested exceptions + * Build a cascaded message from an exception and all its nested exceptions. * @param throwable the top level exception * @return cascaded message string */ @@ -100,7 +100,6 @@ public class ApexException extends Exception { } /** - * * Get the object on which the exception was thrown. * * @return The object on which the exception was thrown diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/ApexRuntimeException.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/ApexRuntimeException.java index 5724b487c..b4240ad0f 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/ApexRuntimeException.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/ApexRuntimeException.java @@ -55,21 +55,21 @@ public class ApexRuntimeException extends RuntimeException { * Instantiates a new apex runtime exception. * * @param message the message on the exception - * @param e the exception that caused this Apex exception + * @param exception the exception that caused this Apex exception */ - public ApexRuntimeException(final String message, final Exception e) { - this(message, e, null); + public ApexRuntimeException(final String message, final Exception exception) { + this(message, exception, null); } /** * Instantiates a new apex runtime exception. * * @param message the message on the exception - * @param e the exception that caused this Apex exception + * @param exception the exception that caused this Apex exception * @param object the object that the exception was thrown on */ - public ApexRuntimeException(final String message, final Exception e, final Object object) { - super(message, e); + public ApexRuntimeException(final String message, final Exception exception, final Object object) { + super(message, exception); this.object = object; } diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxArtifactKey.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxArtifactKey.java index e08c3c65f..1f906ea22 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxArtifactKey.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxArtifactKey.java @@ -38,15 +38,16 @@ import org.onap.policy.apex.model.utilities.Assertions; * An artifact key uniquely identifies every first order entity in the system. Every first order concept in the system * must have an {@link AxArtifactKey} to identify it. Concepts that are wholly contained in another concept are * identified using a {@link AxReferenceKey} key. - *

- * Key validation checks that the name and version fields match the {@link NAME_REGEXP} and {@link VERSION_REGEXP} + * + *

Key validation checks that the name and version fields match the {@link NAME_REGEXP} and {@link VERSION_REGEXP} * regular expressions respectively. */ @Embeddable @XmlAccessorType(XmlAccessType.FIELD) @XmlRootElement(name = "apexArtifactKey", namespace = "http://www.onap.org/policy/apex-pdp") -@XmlType(name = "AxArtifactKey", namespace = "http://www.onap.org/policy/apex-pdp", propOrder = { "name", "version" }) +@XmlType(name = "AxArtifactKey", namespace = "http://www.onap.org/policy/apex-pdp", propOrder = + { "name", "version" }) public class AxArtifactKey extends AxKey { private static final long serialVersionUID = 8932717618579392561L; @@ -70,10 +71,9 @@ public class AxArtifactKey extends AxKey { } /** - * Copy constructor + * Copy constructor. * - * @param copyConcept - * the concept to copy from + * @param copyConcept the concept to copy from */ public AxArtifactKey(final AxArtifactKey copyConcept) { super(copyConcept); @@ -82,10 +82,8 @@ public class AxArtifactKey extends AxKey { /** * Constructor to create a key with the specified name and version. * - * @param name - * the key name - * @param version - * the key version + * @param name the key name + * @param version the key version */ public AxArtifactKey(final String name, final String version) { super(); @@ -96,8 +94,7 @@ public class AxArtifactKey extends AxKey { /** * Constructor to create a key using the key and version from the specified key ID. * - * @param id - * the key ID in a format that respects the {@link KEY_ID_REGEXP} + * @param id the key ID in a format that respects the {@link KEY_ID_REGEXP} */ public AxArtifactKey(final String id) { Assertions.argumentNotNull(id, "id may not be null"); @@ -152,7 +149,7 @@ public class AxArtifactKey extends AxKey { * @see org.onap.policy.apex.model.basicmodel.concepts.AxKey#getID() */ @Override - public String getID() { + public String getId() { return name + ':' + version; } @@ -168,8 +165,7 @@ public class AxArtifactKey extends AxKey { /** * Sets the key name. * - * @param name - * the key name + * @param name the key name */ public void setName(final String name) { this.name = Assertions.validateStringParameter(NAME_TOKEN, name, NAME_REGEXP); @@ -187,8 +183,7 @@ public class AxArtifactKey extends AxKey { /** * Sets the key version. * - * @param version - * the key version + * @param version the key version */ public void setVersion(final String version) { this.version = Assertions.validateStringParameter(VERSION_TOKEN, version, VERSION_REGEXP); @@ -265,8 +260,8 @@ public class AxArtifactKey extends AxKey { "name invalid-" + nameValidationErrorMessage)); } - final String versionValidationErrorMessage = Assertions.getStringParameterValidationMessage(VERSION_TOKEN, version, - VERSION_REGEXP); + final String versionValidationErrorMessage = Assertions.getStringParameterValidationMessage(VERSION_TOKEN, + version, VERSION_REGEXP); if (versionValidationErrorMessage != null) { result.addValidationMessage(new AxValidationMessage(this, this.getClass(), ValidationResult.INVALID, "version invalid-" + versionValidationErrorMessage)); diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxConcept.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxConcept.java index 3d7f5027f..bb6614715 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxConcept.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxConcept.java @@ -40,12 +40,12 @@ public abstract class AxConcept implements Serializable, Comparable { private static final long serialVersionUID = -7434939557282697490L; /** - * Default constructor + * Default constructor. */ public AxConcept() {} /** - * Copy constructor + * Copy constructor. * * @param copyConcept the concept to copy from */ @@ -120,8 +120,8 @@ public abstract class AxConcept implements Serializable, Comparable { * * @return the ID string of this concept */ - public String getID() { - return getKey().getID(); + public String getId() { + return getKey().getId(); } /** @@ -130,10 +130,10 @@ public abstract class AxConcept implements Serializable, Comparable { * @param id the key ID to match against * @return true, if this key matches the ID */ - public final boolean matchesID(final String id) { + public final boolean matchesId(final String id) { Assertions.argumentNotNull(id, "id may not be null"); // Check the ID - return getID().equals(id); + return getId().equals(id); } } diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxConceptGetter.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxConceptGetter.java index 0735f87c3..0284de48a 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxConceptGetter.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxConceptGetter.java @@ -24,9 +24,9 @@ import java.util.Set; /** * This interface is used to allow get methods to be placed on concepts that have embedded maps. - *

- * It forces those concepts with maps to implement the get methods specified on this interface as convenience methods to avoid concept users having to use a - * second level of referencing to access concepts in the the maps. + * + *

It forces those concepts with maps to implement the get methods specified on this interface as convenience methods + * to avoid concept users having to use a second level of referencing to access concepts in the the maps. * * @author Liam Fallon (liam.fallon@ericsson.com) * @param the type of concept on which the interface is applied. diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxConceptGetterImpl.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxConceptGetterImpl.java index b4bff80c8..866de8053 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxConceptGetterImpl.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxConceptGetterImpl.java @@ -82,7 +82,8 @@ public class AxConceptGetterImpl implements AxConceptGetter { break; } foundKey = nextkey; - } while (true); + } + while (true); return conceptMap.get(foundKey); } @@ -147,7 +148,8 @@ public class AxConceptGetterImpl implements AxConceptGetter { break; } returnSet.add(conceptMap.get(foundKey)); - } while (true); + } + while (true); return returnSet; } diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxKey.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxKey.java index 36b49259b..5702a6577 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxKey.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxKey.java @@ -65,14 +65,14 @@ public abstract class AxKey extends AxConcept { } /** - * Default constructor + * Default constructor. */ public AxKey() { super(); } /** - * Copy constructor + * Copy constructor. * * @param copyConcept the concept to copy from */ @@ -86,7 +86,7 @@ public abstract class AxKey extends AxConcept { * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#getID() */ @Override - public abstract String getID(); + public abstract String getId(); /** * Return the result of a compatibility check of two keys. diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxKeyInfo.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxKeyInfo.java index 6c709fa63..2c2952df9 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxKeyInfo.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxKeyInfo.java @@ -37,16 +37,16 @@ import javax.xml.bind.annotation.XmlType; import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter; import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult; -import org.onap.policy.apex.model.basicmodel.dao.converters.CDATAConditioner; -import org.onap.policy.apex.model.basicmodel.dao.converters.UUID2String; +import org.onap.policy.apex.model.basicmodel.dao.converters.CDataConditioner; +import org.onap.policy.apex.model.basicmodel.dao.converters.Uuid2String; import org.onap.policy.apex.model.utilities.Assertions; /** * The key information on an {@link AxArtifactKey} key in an Apex policy model. Each {@link AxArtifactKey} must have an * {@link AxKeyInfo} object. THe information held is the key's UUID and it's description. - *

- * Validation checks that all fields are defined and that the key is valid. It also observes that descriptions are blank - * and warns if the UUID is a zero UUID. + * + *

Validation checks that all fields are defined and that the key is valid. It also observes that descriptions are + * blank and warns if the UUID is a zero UUID. */ @Entity @@ -68,14 +68,14 @@ public class AxKeyInfo extends AxConcept { private AxArtifactKey key; @Column(name = "uuid") - @Convert(converter = UUID2String.class) - @XmlJavaTypeAdapter(value = UUID2String.class) + @Convert(converter = Uuid2String.class) + @XmlJavaTypeAdapter(value = Uuid2String.class) @XmlElement(name = "UUID", required = true) private UUID uuid; @Column(name = "description", length = MAX_DESCRIPTION_LENGTH_8192) - @Convert(converter = CDATAConditioner.class) - @XmlJavaTypeAdapter(value = CDATAConditioner.class) + @Convert(converter = CDataConditioner.class) + @XmlJavaTypeAdapter(value = CDataConditioner.class) @XmlElement(required = true) private String description; @@ -87,7 +87,7 @@ public class AxKeyInfo extends AxConcept { } /** - * Copy constructor + * Copy constructor. * * @param copyConcept the concept to copy from */ @@ -101,7 +101,7 @@ public class AxKeyInfo extends AxConcept { * @param key the key of the concept */ public AxKeyInfo(final AxArtifactKey key) { - this(key, UUID.randomUUID(), "Generated description for concept referred to by key \"" + key.getID() + "\""); + this(key, UUID.randomUUID(), "Generated description for concept referred to by key \"" + key.getId() + "\""); } /** @@ -157,7 +157,7 @@ public class AxKeyInfo extends AxConcept { * * @return the uuid of the concept */ - public UUID getUUID() { + public UUID getUuid() { return uuid; } @@ -313,8 +313,8 @@ public class AxKeyInfo extends AxConcept { if (!uuid.equals(other.uuid)) { return false; } - final String thisdesc = CDATAConditioner.clean(description); - final String otherdesc = CDATAConditioner.clean(other.description); + final String thisdesc = CDataConditioner.clean(description); + final String otherdesc = CDataConditioner.clean(other.description); return thisdesc.equals(otherdesc); } @@ -351,7 +351,7 @@ public class AxKeyInfo extends AxConcept { * @param seed the seed * @return the uuid */ - public static UUID generateReproducibleUUID(final String seed) { + public static UUID generateReproducibleUuid(final String seed) { final Random random; if (seed != null && seed.length() > 0) { random = new Random(seed.hashCode()); diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxKeyInformation.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxKeyInformation.java index 6590ff456..9afec9999 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxKeyInformation.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxKeyInformation.java @@ -50,9 +50,9 @@ import org.onap.policy.apex.model.utilities.Assertions; * {@link AxModel} must have an {@link AxKeyInformation} field. The {@link AxKeyInformation} class implements the helper * methods of the {@link AxConceptGetter} interface to allow {@link AxKeyInfo} instances to be retrieved by calling * methods directly on this class without referencing the contained map. - *

- * Validation checks that the key is not null, that the key information map is not empty, that each key and value in the - * map is defined, that the key in each map entry matches the key if each entry value, and that no duplicate UUIDs + * + *

Validation checks that the key is not null, that the key information map is not empty, that each key and value in + * the map is defined, that the key in each map entry matches the key if each entry value, and that no duplicate UUIDs * exist. Each key information entry is then validated individually. */ @Entity @@ -87,7 +87,7 @@ public class AxKeyInformation extends AxConcept implements AxConceptGetter navigablekeyInfoMap = new TreeMap<>(); @@ -152,7 +152,7 @@ public class AxKeyInformation extends AxConcept implements AxConceptGetter - * Validation checks that each key is valid. + * + *

Validation checks that each key is valid. */ public class AxKeyUse extends AxKey { @@ -46,7 +46,7 @@ public class AxKeyUse extends AxKey { } /** - * Copy constructor + * Copy constructor. * * @param copyConcept the concept to copy from */ @@ -90,8 +90,8 @@ public class AxKeyUse extends AxKey { * @see org.onap.policy.apex.model.basicmodel.concepts.AxKey#getID() */ @Override - public String getID() { - return usedKey.getID(); + public String getId() { + return usedKey.getId(); } /** diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxModel.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxModel.java index dac1d693c..66045db48 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxModel.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxModel.java @@ -46,9 +46,9 @@ import org.onap.policy.apex.model.utilities.Assertions; /** * This class is the base class for all models in Apex. All model classes inherit from this model so all models must * have a key and have key information. - *

- * Validation checks that the model key is valid. It goes on to check for null keys and checks each key for uniqueness - * in the model. A check is carried out to ensure that an {@link AxKeyInfo} instance exists for every + * + *

Validation checks that the model key is valid. It goes on to check for null keys and checks each key for + * uniqueness in the model. A check is carried out to ensure that an {@link AxKeyInfo} instance exists for every * {@link AxArtifactKey} key. For each {@link AxReferenceKey} instance, a check is made that its parent and local name * are nut null and that a {@link AxKeyInfo} entry exists for its parent. Then a check is made that each used * {@link AxArtifactKey} and {@link AxReferenceKey} usage references a key that exists. Finally, a check is made to @@ -61,7 +61,8 @@ import org.onap.policy.apex.model.utilities.Assertions; @XmlRootElement(name = "apexModel", namespace = "http://www.onap.org/policy/apex-pdp") @XmlAccessorType(XmlAccessType.FIELD) -@XmlType(name = "AxModel", namespace = "http://www.onap.org/policy/apex-pdp", propOrder = { "key", "keyInformation" }) +@XmlType(name = "AxModel", namespace = "http://www.onap.org/policy/apex-pdp", propOrder = + { "key", "keyInformation" }) public class AxModel extends AxConcept { private static final String IS_A_NULL_KEY = " is a null key"; @@ -88,7 +89,7 @@ public class AxModel extends AxConcept { } /** - * Copy constructor + * Copy constructor. * * @param copyConcept the concept to copy from */ @@ -197,8 +198,8 @@ public class AxModel extends AxConcept { AxValidationResult result = resultIn; if (key.equals(AxArtifactKey.getNullKey())) { - result.addValidationMessage( - new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID, "key is a null key")); + result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID, + "key is a null key")); } result = key.validate(result); @@ -226,7 +227,7 @@ public class AxModel extends AxConcept { for (final AxReferenceKey referenceKey : referenceKeySet) { if (!artifactKeySet.contains(referenceKey.getParentArtifactKey())) { result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID, - "parent artifact key not found for reference key " + referenceKey)); + "parent artifact key not found for reference key " + referenceKey)); } } @@ -236,7 +237,7 @@ public class AxModel extends AxConcept { for (final AxArtifactKey keyInfoKey : keyInformation.getKeyInfoMap().keySet()) { if (!artifactKeySet.contains(keyInfoKey)) { result.addValidationMessage(new AxValidationMessage(keyInfoKey, this.getClass(), - ValidationResult.WARNING, "key not found for key information entry")); + ValidationResult.WARNING, "key not found for key information entry")); } } @@ -244,7 +245,7 @@ public class AxModel extends AxConcept { } /** - * Check for consistent usage of an artifact key in the model + * Check for consistent usage of an artifact key in the model. * * @param artifactKey The artifact key to check * @param artifactKeySet The set of artifact keys encountered so far, this key is appended to the set @@ -252,23 +253,23 @@ public class AxModel extends AxConcept { * @return the result of the validation */ private AxValidationResult validateArtifactKeyInModel(final AxArtifactKey artifactKey, - final Set artifactKeySet, final AxValidationResult result) { + final Set artifactKeySet, final AxValidationResult result) { // Null key check if (artifactKey.equals(AxArtifactKey.getNullKey())) { result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID, - "key " + artifactKey + IS_A_NULL_KEY)); + "key " + artifactKey + IS_A_NULL_KEY)); } // Null key name start check if (artifactKey.getName().toUpperCase().startsWith(AxKey.NULL_KEY_NAME)) { result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID, - "key " + artifactKey + " name starts with keyword " + AxKey.NULL_KEY_NAME)); + "key " + artifactKey + " name starts with keyword " + AxKey.NULL_KEY_NAME)); } // Unique key check if (artifactKeySet.contains(artifactKey)) { result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID, - "duplicate key " + artifactKey + " found")); + "duplicate key " + artifactKey + " found")); } else { artifactKeySet.add(artifactKey); } @@ -276,14 +277,14 @@ public class AxModel extends AxConcept { // Key information check if (!keyInformation.getKeyInfoMap().containsKey(artifactKey)) { result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID, - "key information not found for key " + artifactKey)); + "key information not found for key " + artifactKey)); } return result; } /** - * Check for consistent usage of a reference key in the model + * Check for consistent usage of a reference key in the model. * * @param artifactKey The reference key to check * @param referenceKeySet The set of reference keys encountered so far, this key is appended to the set @@ -291,35 +292,35 @@ public class AxModel extends AxConcept { * @return the result of the validation */ private AxValidationResult validateReferenceKeyInModel(final AxReferenceKey referenceKey, - final Set referenceKeySet, final AxValidationResult result) { + final Set referenceKeySet, final AxValidationResult result) { // Null key check if (referenceKey.equals(AxReferenceKey.getNullKey())) { result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID, - "key " + referenceKey + IS_A_NULL_KEY)); + "key " + referenceKey + IS_A_NULL_KEY)); } // Null parent key check if (referenceKey.getParentArtifactKey().equals(AxArtifactKey.getNullKey())) { result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID, - "parent artifact key of key " + referenceKey + IS_A_NULL_KEY)); + "parent artifact key of key " + referenceKey + IS_A_NULL_KEY)); } // Null local name check if (referenceKey.getLocalName().equals(AxKey.NULL_KEY_NAME)) { result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID, - "key " + referenceKey + " has a null local name")); + "key " + referenceKey + " has a null local name")); } // Null key name start check if (referenceKey.getParentArtifactKey().getName().toUpperCase().startsWith(AxKey.NULL_KEY_NAME)) { result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID, - "key " + referenceKey + " parent name starts with keyword " + AxKey.NULL_KEY_NAME)); + "key " + referenceKey + " parent name starts with keyword " + AxKey.NULL_KEY_NAME)); } // Unique key check if (referenceKeySet.contains(referenceKey)) { result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID, - "duplicate key " + referenceKey + " found")); + "duplicate key " + referenceKey + " found")); } else { referenceKeySet.add(referenceKey); } @@ -327,14 +328,14 @@ public class AxModel extends AxConcept { // Key information check if (!keyInformation.getKeyInfoMap().containsKey(referenceKey.getParentArtifactKey())) { result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID, - "key information not found for parent key of key " + referenceKey)); + "key information not found for parent key of key " + referenceKey)); } return result; } /** - * Check for consistent usage of cross-key references in the model + * Check for consistent usage of cross-key references in the model. * * @param usedKeySet The set of all keys used in the model * @param artifactKeySet The set of artifact keys encountered so far, this key is appended to the set @@ -343,20 +344,20 @@ public class AxModel extends AxConcept { * @return the result of the validation */ private AxValidationResult validateKeyUses(final Set usedKeySet, final Set artifactKeySet, - final Set referenceKeySet, final AxValidationResult result) { + final Set referenceKeySet, final AxValidationResult result) { // Check all key uses for (final AxKeyUse usedKey : usedKeySet) { if (usedKey.getKey() instanceof AxArtifactKey) { // AxArtifact key usage, check the key exists if (!artifactKeySet.contains(usedKey.getKey())) { result.addValidationMessage(new AxValidationMessage(usedKey.getKey(), this.getClass(), - ValidationResult.INVALID, "an artifact key used in the model is not defined")); + ValidationResult.INVALID, "an artifact key used in the model is not defined")); } } else { // AxReference key usage, check the key exists if (!referenceKeySet.contains(usedKey.getKey())) { result.addValidationMessage(new AxValidationMessage(usedKey.getKey(), this.getClass(), - ValidationResult.INVALID, "a reference key used in the model is not defined")); + ValidationResult.INVALID, "a reference key used in the model is not defined")); } } } @@ -364,7 +365,6 @@ public class AxModel extends AxConcept { return result; } - /* * (non-Javadoc) * diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxReferenceKey.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxReferenceKey.java index 7cb4dd832..55ea95c3a 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxReferenceKey.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxReferenceKey.java @@ -38,16 +38,16 @@ import org.onap.policy.apex.model.utilities.Assertions; * A reference key identifies entities in the system that are contained in other entities. Every contained concept in * the system must have an {@link AxReferenceKey} to identify it. Non-contained first order concepts are identified * using an {@link AxArtifactKey} key. - *

- * An {@link AxReferenceKey} contains an {@link AxArtifactKey} key reference to the first order entity that contains it. - * The local name of the reference key must uniquely identify the referenced concept among those concepts contained in - * the reference key's parent. In other words, if a parent concept has more than one child, the local name in the key of - * all its children must be unique. - *

- * If a reference key's parent is itself a reference key, then the parent's local name must be set in the reference key. - * If the parent is a first order concept, then the parent's local name in the key will be set to NULL. - *

- * Key validation checks that the parent name and parent version fields match the {@link NAME_REGEXP} and + * + *

An {@link AxReferenceKey} contains an {@link AxArtifactKey} key reference to the first order entity that contains + * it. The local name of the reference key must uniquely identify the referenced concept among those concepts contained + * in the reference key's parent. In other words, if a parent concept has more than one child, the local name in the key + * of all its children must be unique. + * + *

If a reference key's parent is itself a reference key, then the parent's local name must be set in the reference + * key. If the parent is a first order concept, then the parent's local name in the key will be set to NULL. + * + *

Key validation checks that the parent name and parent version fields match the {@link NAME_REGEXP} and * {@link VERSION_REGEXP} regular expressions respectively and that the local name fields match the * {@link LOCAL_NAME_REGEXP} regular expression. */ @@ -69,7 +69,8 @@ public class AxReferenceKey extends AxKey { public static final String LOCAL_NAME_REGEXP = "[A-Za-z0-9\\-_\\.]+|^$"; /** Regular expression to specify the structure of IDs in reference keys. */ - public static final String REFERENCE_KEY_ID_REGEXP = "[A-Za-z0-9\\-_]+:[0-9].[0-9].[0-9]:[A-Za-z0-9\\-_]+:[A-Za-z0-9\\-_]+"; + public static final String REFERENCE_KEY_ID_REGEXP = + "[A-Za-z0-9\\-_]+:[0-9].[0-9].[0-9]:[A-Za-z0-9\\-_]+:[A-Za-z0-9\\-_]+"; private static final int PARENT_NAME_FIELD = 0; private static final int PARENT_VERSION_FIELD = 1; @@ -262,7 +263,7 @@ public class AxReferenceKey extends AxKey { * @see org.onap.policy.apex.model.basicmodel.concepts.AxKey#getID() */ @Override - public String getID() { + public String getId() { return parentKeyName + ':' + parentKeyVersion + ':' + parentLocalName + ':' + localName; } diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxValidationResult.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxValidationResult.java index 664cf9500..dbe4c6a75 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxValidationResult.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxValidationResult.java @@ -73,7 +73,7 @@ public class AxValidationResult { * * @return true, if the concept has no warnings or errors */ - public boolean isOK() { + public boolean isOk() { return validationResult == ValidationResult.VALID || validationResult == ValidationResult.OBSERVATION; } diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/ApexDao.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/ApexDao.java index 461f3f113..655e9a99f 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/ApexDao.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/ApexDao.java @@ -43,7 +43,7 @@ public interface ApexDao { * @param daoParameters parameters to use to access the database * @throws ApexException on initialization errors */ - void init(DAOParameters daoParameters) throws ApexException; + void init(DaoParameters daoParameters) throws ApexException; /** * Close the Apex DAO. @@ -70,19 +70,19 @@ public interface ApexDao { * Delete an Apex concept on the database. * * @param the type of the object to delete, a subclass of {@link AxConcept} - * @param aClass the class of the object to delete, a subclass of {@link AxConcept} + * @param someClass the class of the object to delete, a subclass of {@link AxConcept} * @param key the key of the object to delete */ - void delete(Class aClass, AxArtifactKey key); + void delete(Class someClass, AxArtifactKey key); /** * Delete an Apex concept on the database. * * @param the type of the object to delete, a subclass of {@link AxConcept} - * @param aClass the class of the object to delete, a subclass of {@link AxConcept} + * @param someClass the class of the object to delete, a subclass of {@link AxConcept} * @param key the key of the object to delete */ - void delete(Class aClass, AxReferenceKey key); + void delete(Class someClass, AxReferenceKey key); /** * Create a collection of objects in the database. @@ -90,7 +90,7 @@ public interface ApexDao { * @param the type of the object to create, a subclass of {@link AxConcept} * @param objs the objects to create */ - void create(Collection objs); + void createCollection(Collection objs); /** * Delete a collection of objects in the database. @@ -98,103 +98,103 @@ public interface ApexDao { * @param the type of the objects to delete, a subclass of {@link AxConcept} * @param objs the objects to delete */ - void delete(Collection objs); + void deleteCollection(Collection objs); /** * Delete a collection of objects in the database referred to by artifact key. * * @param the type of the objects to delete, a subclass of {@link AxConcept} - * @param aClass the class of the objects to delete, a subclass of {@link AxConcept} + * @param someClass the class of the objects to delete, a subclass of {@link AxConcept} * @param keys the keys of the objects to delete * @return the number of objects deleted */ - int deleteByArtifactKey(Class aClass, Collection keys); + int deleteByArtifactKey(Class someClass, Collection keys); /** * Delete a collection of objects in the database referred to by reference key. * * @param the type of the objects to delete, a subclass of {@link AxConcept} - * @param aClass the class of the objects to delete, a subclass of {@link AxConcept} + * @param someClass the class of the objects to delete, a subclass of {@link AxConcept} * @param keys the keys of the objects to delete * @return the number of objects deleted */ - int deleteByReferenceKey(Class aClass, Collection keys); + int deleteByReferenceKey(Class someClass, Collection keys); /** * Delete all objects of a given class in the database. * * @param the type of the objects to delete, a subclass of {@link AxConcept} - * @param aClass the class of the objects to delete, a subclass of {@link AxConcept} + * @param someClass the class of the objects to delete, a subclass of {@link AxConcept} */ - void deleteAll(Class aClass); + void deleteAll(Class someClass); /** * Get an object from the database, referred to by artifact key. * * @param the type of the object to get, a subclass of {@link AxConcept} - * @param aClass the class of the object to get, a subclass of {@link AxConcept} + * @param someClass the class of the object to get, a subclass of {@link AxConcept} * @param key the key of the object to get * @return the object that was retrieved from the database */ - T get(Class aClass, AxArtifactKey key); + T get(Class someClass, AxArtifactKey key); /** * Get an object from the database, referred to by reference key. * * @param the type of the object to get, a subclass of {@link AxConcept} - * @param aClass the class of the object to get, a subclass of {@link AxConcept} + * @param someClass the class of the object to get, a subclass of {@link AxConcept} * @param key the key of the object to get * @return the object that was retrieved from the database or null if the object was not retrieved */ - T get(Class aClass, AxReferenceKey key); + T get(Class someClass, AxReferenceKey key); /** * Get all the objects in the database of a given type. * * @param the type of the objects to get, a subclass of {@link AxConcept} - * @param aClass the class of the objects to get, a subclass of {@link AxConcept} + * @param someClass the class of the objects to get, a subclass of {@link AxConcept} * @return the objects or null if no objects were retrieved */ - List getAll(Class aClass); + List getAll(Class someClass); /** * Get all the objects in the database of the given type with the given parent artifact key. * * @param the type of the objects to get, a subclass of {@link AxConcept} - * @param aClass the class of the objects to get, a subclass of {@link AxConcept} + * @param someClass the class of the objects to get, a subclass of {@link AxConcept} * @param parentKey the parent key of the concepts to get * @return the all */ - List getAll(Class aClass, AxArtifactKey parentKey); + List getAll(Class someClass, AxArtifactKey parentKey); /** * Get a concept from the database with the given artifact key. * * @param the type of the object to get, a subclass of {@link AxConcept} - * @param aClass the class of the object to get, a subclass of {@link AxConcept} - * @param artifactID the artifact key of the concept to get + * @param someClass the class of the object to get, a subclass of {@link AxConcept} + * @param artifactId the artifact key of the concept to get * @return the concept that matches the key or null if the concept is not retrieved */ - T getArtifact(Class aClass, AxArtifactKey artifactID); + T getArtifact(Class someClass, AxArtifactKey artifactId); /** * Get a concept from the database with the given reference key. * * @param the type of the object to get, a subclass of {@link AxConcept} - * @param aClass the class of the object to get, a subclass of {@link AxConcept} - * @param artifactID the artifact key of the concept to get + * @param someClass the class of the object to get, a subclass of {@link AxConcept} + * @param artifactId the artifact key of the concept to get * @return the concept that matches the key or null if the concept is not retrieved */ - T getArtifact(Class aClass, AxReferenceKey artifactID); + T getArtifact(Class someClass, AxReferenceKey artifactId); /** * Get the number of instances of a concept that exist in the database. * * @param the type of the object to get, a subclass of {@link AxConcept} - * @param aClass the class of the object to get, a subclass of {@link AxConcept} + * @param someClass the class of the object to get, a subclass of {@link AxConcept} * @return the number of instances of the concept in the database */ - long size(Class aClass); + long size(Class someClass); /** * Update a concept in the database. diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/ApexDaoFactory.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/ApexDaoFactory.java index 50724d2d7..82838edf1 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/ApexDaoFactory.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/ApexDaoFactory.java @@ -27,7 +27,7 @@ import org.slf4j.ext.XLoggerFactory; /** * This factory class returns an Apex DAO for the configured persistence mechanism. The factory uses the plugin class - * specified in {@link DAOParameters} to instantiate a DAO instance. + * specified in {@link DaoParameters} to instantiate a DAO instance. * * @author Liam Fallon (liam.fallon@ericsson.com) */ @@ -42,7 +42,7 @@ public class ApexDaoFactory { * @return the Apex DAO * @throws ApexException on invalid JPA plugins */ - public ApexDao createApexDao(final DAOParameters daoParameters) throws ApexException { + public ApexDao createApexDao(final DaoParameters daoParameters) throws ApexException { Assertions.argumentNotNull(daoParameters, ApexException.class, "Parameter \"daoParameters\" may not be null"); // Get the class for the DAO using reflection diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/DAOParameters.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/DAOParameters.java deleted file mode 100644 index 5a44d18a8..000000000 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/DAOParameters.java +++ /dev/null @@ -1,125 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2016-2018 Ericsson. All rights reserved. - * ================================================================================ - * 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. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ - -package org.onap.policy.apex.model.basicmodel.dao; - -import java.util.Properties; - -/** - * This class is a POJO that holds properties for Apex DAOs. - * - * @author Liam Fallon (liam.fallon@ericsson.com) - */ -public class DAOParameters { - /** The default Apex DAO plugin class. */ - public static final String DEFAULT_PLUGIN_CLASS = "org.onap.policy.apex.model.basicmodel.dao.impl.DefaultApexDao"; - - private String pluginClass = DEFAULT_PLUGIN_CLASS; - private String persistenceUnit; - - private Properties jdbcProperties = new Properties(); - - /** - * Gets the DAO plugin class, this is the DAO class to use and it must implement the {@link ApexDao} interface. - * - * @return the DAO plugin class - */ - public String getPluginClass() { - return pluginClass; - } - - /** - * Sets the DAO plugin class, a class that implements the {@link ApexDao} interface. - * - * @param daoPluginClass the DAO plugin class - */ - public void setPluginClass(final String daoPluginClass) { - pluginClass = daoPluginClass; - } - - /** - * Gets the persistence unit for the DAO. The persistence unit defines the JDBC properties the DAO will use. The - * persistence unit must defined in the {@code META-INF/persistence.xml} resource file - * - * @return the persistence unit to use for JDBC access - */ - public String getPersistenceUnit() { - return persistenceUnit; - } - - /** - * Sets the persistence unit for the DAO. The persistence unit defines the JDBC properties the DAO will use. The - * persistence unit must defined in the {@code META-INF/persistence.xml} resource file - * - * @param daoPersistenceUnit the persistence unit to use for JDBC access - */ - public void setPersistenceUnit(final String daoPersistenceUnit) { - persistenceUnit = daoPersistenceUnit; - } - - /** - * Gets the JDBC properties. - * - * @return the JDBC properties - */ - public Properties getJdbcProperties() { - return jdbcProperties; - } - - /** - * Sets the JDBC properties. - * - * @param jdbcProperties the JDBC properties - */ - public void setJdbcProperties(final Properties jdbcProperties) { - this.jdbcProperties = jdbcProperties; - } - - /** - * Gets a single JDBC property. - * - * @param key the key of the property - * @return the JDBC property - */ - public String getJdbcProperty(final String key) { - return jdbcProperties.getProperty(key); - } - - /** - * Sets a single JDBC property. - * - * @param key the key of the property - * @param value the value of the JDBC property - */ - public void setJdbcProperty(final String key, final String value) { - jdbcProperties.setProperty(key, value); - } - - /* - * (non-Javadoc) - * - * @see java.lang.Object#toString() - */ - @Override - public String toString() { - return "DAOParameters [pluginClass=" + pluginClass + ", persistenceUnit=" + persistenceUnit - + ", jdbcProperties=" + jdbcProperties + "]"; - } -} diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/DaoParameters.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/DaoParameters.java new file mode 100644 index 000000000..cdaf64ed0 --- /dev/null +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/DaoParameters.java @@ -0,0 +1,125 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2016-2018 Ericsson. All rights reserved. + * ================================================================================ + * 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. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.policy.apex.model.basicmodel.dao; + +import java.util.Properties; + +/** + * This class is a POJO that holds properties for Apex DAOs. + * + * @author Liam Fallon (liam.fallon@ericsson.com) + */ +public class DaoParameters { + /** The default Apex DAO plugin class. */ + public static final String DEFAULT_PLUGIN_CLASS = "org.onap.policy.apex.model.basicmodel.dao.impl.DefaultApexDao"; + + private String pluginClass = DEFAULT_PLUGIN_CLASS; + private String persistenceUnit; + + private Properties jdbcProperties = new Properties(); + + /** + * Gets the DAO plugin class, this is the DAO class to use and it must implement the {@link ApexDao} interface. + * + * @return the DAO plugin class + */ + public String getPluginClass() { + return pluginClass; + } + + /** + * Sets the DAO plugin class, a class that implements the {@link ApexDao} interface. + * + * @param daoPluginClass the DAO plugin class + */ + public void setPluginClass(final String daoPluginClass) { + pluginClass = daoPluginClass; + } + + /** + * Gets the persistence unit for the DAO. The persistence unit defines the JDBC properties the DAO will use. The + * persistence unit must defined in the {@code META-INF/persistence.xml} resource file + * + * @return the persistence unit to use for JDBC access + */ + public String getPersistenceUnit() { + return persistenceUnit; + } + + /** + * Sets the persistence unit for the DAO. The persistence unit defines the JDBC properties the DAO will use. The + * persistence unit must defined in the {@code META-INF/persistence.xml} resource file + * + * @param daoPersistenceUnit the persistence unit to use for JDBC access + */ + public void setPersistenceUnit(final String daoPersistenceUnit) { + persistenceUnit = daoPersistenceUnit; + } + + /** + * Gets the JDBC properties. + * + * @return the JDBC properties + */ + public Properties getJdbcProperties() { + return jdbcProperties; + } + + /** + * Sets the JDBC properties. + * + * @param jdbcProperties the JDBC properties + */ + public void setJdbcProperties(final Properties jdbcProperties) { + this.jdbcProperties = jdbcProperties; + } + + /** + * Gets a single JDBC property. + * + * @param key the key of the property + * @return the JDBC property + */ + public String getJdbcProperty(final String key) { + return jdbcProperties.getProperty(key); + } + + /** + * Sets a single JDBC property. + * + * @param key the key of the property + * @param value the value of the JDBC property + */ + public void setJdbcProperty(final String key, final String value) { + jdbcProperties.setProperty(key, value); + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#toString() + */ + @Override + public String toString() { + return "DAOParameters [pluginClass=" + pluginClass + ", persistenceUnit=" + persistenceUnit + + ", jdbcProperties=" + jdbcProperties + "]"; + } +} diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/converters/CDATAConditioner.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/converters/CDATAConditioner.java deleted file mode 100644 index 9e840da2c..000000000 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/converters/CDATAConditioner.java +++ /dev/null @@ -1,91 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2016-2018 Ericsson. All rights reserved. - * ================================================================================ - * 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. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ - -package org.onap.policy.apex.model.basicmodel.dao.converters; - -import javax.persistence.AttributeConverter; -import javax.persistence.Converter; -import javax.xml.bind.annotation.adapters.XmlAdapter; - -/** - * The Class CDATAConditioner converts a CDATA String to and from database format by removing spaces at the ends of - * lines and platform-specific new line endings. - * - * @author John Keeney (John.Keeney@ericsson.com) - */ -@Converter -public class CDATAConditioner extends XmlAdapter implements AttributeConverter { - - private static final String NL = "\n"; - - /* - * (non-Javadoc) - * - * @see javax.persistence.AttributeConverter#convertToDatabaseColumn(java.lang.Object) - */ - @Override - public String convertToDatabaseColumn(final String raw) { - return clean(raw); - } - - /* - * (non-Javadoc) - * - * @see javax.persistence.AttributeConverter#convertToEntityAttribute(java.lang.Object) - */ - @Override - public String convertToEntityAttribute(final String db) { - return clean(db); - } - - /* - * (non-Javadoc) - * - * @see javax.xml.bind.annotation.adapters.XmlAdapter - */ - @Override - public String unmarshal(final String v) throws Exception { - return this.convertToEntityAttribute(v); - } - - /* - * (non-Javadoc) - * - * @see javax.xml.bind.annotation.adapters.XmlAdapter - */ - @Override - public String marshal(final String v) throws Exception { - return this.convertToDatabaseColumn(v); - } - - /** - * Clean. - * - * @param in the in - * @return the string - */ - public static final String clean(final String in) { - if (in == null) { - return null; - } else { - return in.replaceAll("\\s+$", "").replaceAll("\\r?\\n", NL); - } - } -} diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/converters/CDataConditioner.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/converters/CDataConditioner.java new file mode 100644 index 000000000..93c891b13 --- /dev/null +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/converters/CDataConditioner.java @@ -0,0 +1,91 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2016-2018 Ericsson. All rights reserved. + * ================================================================================ + * 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. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.policy.apex.model.basicmodel.dao.converters; + +import javax.persistence.AttributeConverter; +import javax.persistence.Converter; +import javax.xml.bind.annotation.adapters.XmlAdapter; + +/** + * The Class CDATAConditioner converts a CDATA String to and from database format by removing spaces at the ends of + * lines and platform-specific new line endings. + * + * @author John Keeney (John.Keeney@ericsson.com) + */ +@Converter +public class CDataConditioner extends XmlAdapter implements AttributeConverter { + + private static final String NL = "\n"; + + /* + * (non-Javadoc) + * + * @see javax.persistence.AttributeConverter#convertToDatabaseColumn(java.lang.Object) + */ + @Override + public String convertToDatabaseColumn(final String raw) { + return clean(raw); + } + + /* + * (non-Javadoc) + * + * @see javax.persistence.AttributeConverter#convertToEntityAttribute(java.lang.Object) + */ + @Override + public String convertToEntityAttribute(final String db) { + return clean(db); + } + + /* + * (non-Javadoc) + * + * @see javax.xml.bind.annotation.adapters.XmlAdapter + */ + @Override + public String unmarshal(final String value) throws Exception { + return this.convertToEntityAttribute(value); + } + + /* + * (non-Javadoc) + * + * @see javax.xml.bind.annotation.adapters.XmlAdapter + */ + @Override + public String marshal(final String value) throws Exception { + return this.convertToDatabaseColumn(value); + } + + /** + * Clean. + * + * @param in the in + * @return the string + */ + public static final String clean(final String in) { + if (in == null) { + return null; + } else { + return in.replaceAll("\\s+$", "").replaceAll("\\r?\\n", NL); + } + } +} diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/converters/UUID2String.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/converters/UUID2String.java deleted file mode 100644 index f26dfc2de..000000000 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/converters/UUID2String.java +++ /dev/null @@ -1,83 +0,0 @@ -/* - * ============LICENSE_START======================================================= - * Copyright (C) 2016-2018 Ericsson. All rights reserved. - * ================================================================================ - * 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. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ - -package org.onap.policy.apex.model.basicmodel.dao.converters; - -import java.util.UUID; - -import javax.persistence.AttributeConverter; -import javax.persistence.Converter; -import javax.xml.bind.annotation.adapters.XmlAdapter; - -/** - * The Class UUIDConverter converts a UUID to and from database format. - * - * @author Liam Fallon (liam.fallon@ericsson.com) - */ -@Converter -public class UUID2String extends XmlAdapter implements AttributeConverter { - - /* - * (non-Javadoc) - * - * @see javax.persistence.AttributeConverter#convertToDatabaseColumn(java.lang.Object) - */ - @Override - public String convertToDatabaseColumn(final UUID uuid) { - String returnString; - if (uuid == null) { - returnString = ""; - } - else { - returnString = uuid.toString(); - } - return returnString; - } - - /* - * (non-Javadoc) - * - * @see javax.persistence.AttributeConverter#convertToEntityAttribute(java.lang.Object) - */ - @Override - public UUID convertToEntityAttribute(final String uuidString) { - return UUID.fromString(uuidString); - } - - /* - * (non-Javadoc) - * - * @see javax.xml.bind.annotation.adapters.XmlAdapter - */ - @Override - public UUID unmarshal(final String v) throws Exception { - return this.convertToEntityAttribute(v); - } - - /* - * (non-Javadoc) - * - * @see javax.xml.bind.annotation.adapters.XmlAdapter - */ - @Override - public String marshal(final UUID v) throws Exception { - return this.convertToDatabaseColumn(v); - } -} diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/converters/Uuid2String.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/converters/Uuid2String.java new file mode 100644 index 000000000..3f7bddbd1 --- /dev/null +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/converters/Uuid2String.java @@ -0,0 +1,83 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2016-2018 Ericsson. All rights reserved. + * ================================================================================ + * 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. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.policy.apex.model.basicmodel.dao.converters; + +import java.util.UUID; + +import javax.persistence.AttributeConverter; +import javax.persistence.Converter; +import javax.xml.bind.annotation.adapters.XmlAdapter; + +/** + * The Class UUIDConverter converts a UUID to and from database format. + * + * @author Liam Fallon (liam.fallon@ericsson.com) + */ +@Converter +public class Uuid2String extends XmlAdapter implements AttributeConverter { + + /* + * (non-Javadoc) + * + * @see javax.persistence.AttributeConverter#convertToDatabaseColumn(java.lang.Object) + */ + @Override + public String convertToDatabaseColumn(final UUID uuid) { + String returnString; + if (uuid == null) { + returnString = ""; + } + else { + returnString = uuid.toString(); + } + return returnString; + } + + /* + * (non-Javadoc) + * + * @see javax.persistence.AttributeConverter#convertToEntityAttribute(java.lang.Object) + */ + @Override + public UUID convertToEntityAttribute(final String uuidString) { + return UUID.fromString(uuidString); + } + + /* + * (non-Javadoc) + * + * @see javax.xml.bind.annotation.adapters.XmlAdapter + */ + @Override + public UUID unmarshal(final String value) throws Exception { + return this.convertToEntityAttribute(value); + } + + /* + * (non-Javadoc) + * + * @see javax.xml.bind.annotation.adapters.XmlAdapter + */ + @Override + public String marshal(final UUID value) throws Exception { + return this.convertToDatabaseColumn(value); + } +} diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/impl/DefaultApexDao.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/impl/DefaultApexDao.java index 228362bce..7945a0837 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/impl/DefaultApexDao.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/impl/DefaultApexDao.java @@ -34,7 +34,7 @@ import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey; import org.onap.policy.apex.model.basicmodel.concepts.AxConcept; import org.onap.policy.apex.model.basicmodel.concepts.AxReferenceKey; import org.onap.policy.apex.model.basicmodel.dao.ApexDao; -import org.onap.policy.apex.model.basicmodel.dao.DAOParameters; +import org.onap.policy.apex.model.basicmodel.dao.DaoParameters; import org.slf4j.ext.XLogger; import org.slf4j.ext.XLoggerFactory; @@ -66,7 +66,7 @@ public class DefaultApexDao implements ApexDao { * org.onap.policy.apex.model.basicmodel.dao.ApexDao#init(org.onap.policy.apex.model.basicmodel.dao.DAOParameters) */ @Override - public void init(final DAOParameters daoParameters) throws ApexException { + public void init(final DaoParameters daoParameters) throws ApexException { if (daoParameters == null || daoParameters.getPersistenceUnit() == null) { LOGGER.error("Apex persistence unit parameter not set"); throw new ApexException("Apex persistence unit parameter not set"); @@ -75,11 +75,12 @@ public class DefaultApexDao implements ApexDao { LOGGER.debug("Creating Apex persistence unit \"" + daoParameters.getPersistenceUnit() + "\" . . ."); try { emf = Persistence.createEntityManagerFactory(daoParameters.getPersistenceUnit(), - daoParameters.getJdbcProperties()); + daoParameters.getJdbcProperties()); } catch (final Exception e) { LOGGER.warn("Creation of Apex persistence unit \"" + daoParameters.getPersistenceUnit() + "\" failed", e); throw new ApexException( - "Creation of Apex persistence unit \"" + daoParameters.getPersistenceUnit() + "\" failed", e); + "Creation of Apex persistence unit \"" + daoParameters.getPersistenceUnit() + "\" failed", + e); } LOGGER.debug("Created Apex persistence unit \"" + daoParameters.getPersistenceUnit() + "\""); } @@ -159,15 +160,15 @@ public class DefaultApexDao implements ApexDao { * org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey) */ @Override - public void delete(final Class aClass, final AxArtifactKey key) { + public void delete(final Class someClass, final AxArtifactKey key) { if (key == null) { return; } final EntityManager mg = getEntityManager(); try { mg.getTransaction().begin(); - mg.createQuery(DELETE_FROM + aClass.getSimpleName() + C_WHERE_C_KEY_NAME + key.getName() + AND_C_KEY_VERSION - + key.getVersion() + "'", aClass).executeUpdate(); + mg.createQuery(DELETE_FROM + someClass.getSimpleName() + C_WHERE_C_KEY_NAME + key.getName() + + AND_C_KEY_VERSION + key.getVersion() + "'", someClass).executeUpdate(); mg.getTransaction().commit(); } finally { mg.close(); @@ -181,16 +182,16 @@ public class DefaultApexDao implements ApexDao { * org.onap.policy.apex.model.basicmodel.concepts.AxReferenceKey) */ @Override - public void delete(final Class aClass, final AxReferenceKey key) { + public void delete(final Class someClass, final AxReferenceKey key) { if (key == null) { return; } final EntityManager mg = getEntityManager(); try { mg.getTransaction().begin(); - mg.createQuery(DELETE_FROM + aClass.getSimpleName() + C_WHERE_C_KEY_PARENT_KEY_NAME + key.getParentKeyName() - + AND_C_KEY_PARENT_KEY_VERSION + key.getParentKeyVersion() + AND_C_KEY_LOCAL_NAME - + key.getLocalName() + "'", aClass).executeUpdate(); + mg.createQuery(DELETE_FROM + someClass.getSimpleName() + C_WHERE_C_KEY_PARENT_KEY_NAME + + key.getParentKeyName() + AND_C_KEY_PARENT_KEY_VERSION + key.getParentKeyVersion() + + AND_C_KEY_LOCAL_NAME + key.getLocalName() + "'", someClass).executeUpdate(); mg.getTransaction().commit(); } finally { mg.close(); @@ -203,7 +204,7 @@ public class DefaultApexDao implements ApexDao { * @see org.onap.policy.apex.model.basicmodel.dao.ApexDao#create(java.util.Collection) */ @Override - public void create(final Collection objs) { + public void createCollection(final Collection objs) { if (objs == null || objs.isEmpty()) { return; } @@ -225,7 +226,7 @@ public class DefaultApexDao implements ApexDao { * @see org.onap.policy.apex.model.basicmodel.dao.ApexDao#delete(java.util.Collection) */ @Override - public void delete(final Collection objs) { + public void deleteCollection(final Collection objs) { if (objs == null || objs.isEmpty()) { return; } @@ -247,7 +248,8 @@ public class DefaultApexDao implements ApexDao { * @see org.onap.policy.apex.model.basicmodel.dao.ApexDao#deleteByArtifactKey(java.lang.Class, java.util.Collection) */ @Override - public int deleteByArtifactKey(final Class aClass, final Collection keys) { + public int deleteByArtifactKey(final Class someClass, + final Collection keys) { if (keys == null || keys.isEmpty()) { return 0; } @@ -256,8 +258,10 @@ public class DefaultApexDao implements ApexDao { try { mg.getTransaction().begin(); for (final AxArtifactKey key : keys) { - deletedCount += mg.createQuery(DELETE_FROM + aClass.getSimpleName() + C_WHERE_C_KEY_NAME + key.getName() - + AND_C_KEY_VERSION + key.getVersion() + "'", aClass).executeUpdate(); + deletedCount += mg + .createQuery(DELETE_FROM + someClass.getSimpleName() + C_WHERE_C_KEY_NAME + + key.getName() + AND_C_KEY_VERSION + key.getVersion() + "'", someClass) + .executeUpdate(); } mg.getTransaction().commit(); } finally { @@ -273,8 +277,8 @@ public class DefaultApexDao implements ApexDao { * java.util.Collection) */ @Override - public int deleteByReferenceKey(final Class aClass, - final Collection keys) { + public int deleteByReferenceKey(final Class someClass, + final Collection keys) { if (keys == null || keys.isEmpty()) { return 0; } @@ -283,12 +287,9 @@ public class DefaultApexDao implements ApexDao { try { mg.getTransaction().begin(); for (final AxReferenceKey key : keys) { - deletedCount += - mg.createQuery( - DELETE_FROM + aClass.getSimpleName() + C_WHERE_C_KEY_PARENT_KEY_NAME - + key.getParentKeyName() + AND_C_KEY_PARENT_KEY_VERSION - + key.getParentKeyVersion() + AND_C_KEY_LOCAL_NAME + key.getLocalName() + "'", - aClass).executeUpdate(); + deletedCount += mg.createQuery(DELETE_FROM + someClass.getSimpleName() + C_WHERE_C_KEY_PARENT_KEY_NAME + + key.getParentKeyName() + AND_C_KEY_PARENT_KEY_VERSION + key.getParentKeyVersion() + + AND_C_KEY_LOCAL_NAME + key.getLocalName() + "'", someClass).executeUpdate(); } mg.getTransaction().commit(); } finally { @@ -303,11 +304,11 @@ public class DefaultApexDao implements ApexDao { * @see org.onap.policy.apex.model.basicmodel.dao.ApexDao#deleteAll(java.lang.Class) */ @Override - public void deleteAll(final Class aClass) { + public void deleteAll(final Class someClass) { final EntityManager mg = getEntityManager(); try { mg.getTransaction().begin(); - mg.createQuery(DELETE_FROM + aClass.getSimpleName() + " c ", aClass).executeUpdate(); + mg.createQuery(DELETE_FROM + someClass.getSimpleName() + " c ", someClass).executeUpdate(); mg.getTransaction().commit(); } finally { mg.close(); @@ -321,21 +322,21 @@ public class DefaultApexDao implements ApexDao { * org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey) */ @Override - public T get(final Class aClass, final AxArtifactKey key) { - if (aClass == null) { + public T get(final Class someClass, final AxArtifactKey key) { + if (someClass == null) { return null; } final EntityManager mg = getEntityManager(); try { - final T t = mg.find(aClass, key); + final T t = mg.find(someClass, key); if (t != null) { // This clone is created to force the JPA DAO to recurse down through the object try { - final T clonedT = aClass.newInstance(); + final T clonedT = someClass.newInstance(); t.copyTo(clonedT); return clonedT; } catch (final Exception e) { - LOGGER.warn("Could not clone object of class \"" + aClass.getCanonicalName() + "\"", e); + LOGGER.warn("Could not clone object of class \"" + someClass.getCanonicalName() + "\"", e); return null; } } else { @@ -353,20 +354,20 @@ public class DefaultApexDao implements ApexDao { * org.onap.policy.apex.model.basicmodel.concepts.AxReferenceKey) */ @Override - public T get(final Class aClass, final AxReferenceKey key) { - if (aClass == null) { + public T get(final Class someClass, final AxReferenceKey key) { + if (someClass == null) { return null; } final EntityManager mg = getEntityManager(); try { - final T t = mg.find(aClass, key); + final T t = mg.find(someClass, key); if (t != null) { try { - final T clonedT = aClass.newInstance(); + final T clonedT = someClass.newInstance(); t.copyTo(clonedT); return clonedT; } catch (final Exception e) { - LOGGER.warn("Could not clone object of class \"" + aClass.getCanonicalName() + "\"", e); + LOGGER.warn("Could not clone object of class \"" + someClass.getCanonicalName() + "\"", e); return null; } } else { @@ -383,13 +384,13 @@ public class DefaultApexDao implements ApexDao { * @see org.onap.policy.apex.model.basicmodel.dao.ApexDao#getAll(java.lang.Class) */ @Override - public List getAll(final Class aClass) { - if (aClass == null) { + public List getAll(final Class someClass) { + if (someClass == null) { return Collections.emptyList(); } final EntityManager mg = getEntityManager(); try { - return mg.createQuery(SELECT_C_FROM + aClass.getSimpleName() + " c", aClass).getResultList(); + return mg.createQuery(SELECT_C_FROM + someClass.getSimpleName() + " c", someClass).getResultList(); } finally { mg.close(); } @@ -402,16 +403,15 @@ public class DefaultApexDao implements ApexDao { * org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey) */ @Override - public List getAll(final Class aClass, final AxArtifactKey parentKey) { - if (aClass == null) { + public List getAll(final Class someClass, final AxArtifactKey parentKey) { + if (someClass == null) { return Collections.emptyList(); } final EntityManager mg = getEntityManager(); try { - return mg - .createQuery(SELECT_C_FROM + aClass.getSimpleName() + C_WHERE_C_KEY_PARENT_KEY_NAME - + parentKey.getName() + AND_C_KEY_PARENT_KEY_VERSION + parentKey.getVersion() + "'", aClass) - .getResultList(); + return mg.createQuery(SELECT_C_FROM + someClass.getSimpleName() + C_WHERE_C_KEY_PARENT_KEY_NAME + + parentKey.getName() + AND_C_KEY_PARENT_KEY_VERSION + parentKey.getVersion() + "'", + someClass).getResultList(); } finally { mg.close(); } @@ -424,15 +424,15 @@ public class DefaultApexDao implements ApexDao { * org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey) */ @Override - public T getArtifact(final Class aClass, final AxArtifactKey key) { - if (aClass == null || key == null) { + public T getArtifact(final Class someClass, final AxArtifactKey key) { + if (someClass == null || key == null) { return null; } final EntityManager mg = getEntityManager(); List ret; try { - ret = mg.createQuery(SELECT_C_FROM + aClass.getSimpleName() + C_WHERE_C_KEY_NAME + key.getName() - + AND_C_KEY_VERSION + key.getVersion() + "'", aClass).getResultList(); + ret = mg.createQuery(SELECT_C_FROM + someClass.getSimpleName() + C_WHERE_C_KEY_NAME + key.getName() + + AND_C_KEY_VERSION + key.getVersion() + "'", someClass).getResultList(); } finally { mg.close(); } @@ -440,8 +440,8 @@ public class DefaultApexDao implements ApexDao { return null; } if (ret.size() > 1) { - throw new IllegalArgumentException("More than one result was returned for search for " + aClass - + " with key " + key.getID() + ": " + ret); + throw new IllegalArgumentException("More than one result was returned for search for " + someClass + + " with key " + key.getId() + ": " + ret); } return ret.get(0); } @@ -453,16 +453,16 @@ public class DefaultApexDao implements ApexDao { * org.onap.policy.apex.model.basicmodel.concepts.AxReferenceKey) */ @Override - public T getArtifact(final Class aClass, final AxReferenceKey key) { - if (aClass == null || key == null) { + public T getArtifact(final Class someClass, final AxReferenceKey key) { + if (someClass == null || key == null) { return null; } final EntityManager mg = getEntityManager(); List ret; try { - ret = mg.createQuery(SELECT_C_FROM + aClass.getSimpleName() + C_WHERE_C_KEY_PARENT_KEY_NAME - + key.getParentKeyName() + AND_C_KEY_PARENT_KEY_VERSION + key.getParentKeyVersion() - + AND_C_KEY_LOCAL_NAME + key.getLocalName() + "'", aClass).getResultList(); + ret = mg.createQuery(SELECT_C_FROM + someClass.getSimpleName() + C_WHERE_C_KEY_PARENT_KEY_NAME + + key.getParentKeyName() + AND_C_KEY_PARENT_KEY_VERSION + key.getParentKeyVersion() + + AND_C_KEY_LOCAL_NAME + key.getLocalName() + "'", someClass).getResultList(); } finally { mg.close(); } @@ -470,8 +470,8 @@ public class DefaultApexDao implements ApexDao { return null; } if (ret.size() > 1) { - throw new IllegalArgumentException("More than one result was returned for search for " + aClass - + " with key " + key.getID() + ": " + ret); + throw new IllegalArgumentException("More than one result was returned for search for " + someClass + + " with key " + key.getId() + ": " + ret); } return ret.get(0); } @@ -503,15 +503,15 @@ public class DefaultApexDao implements ApexDao { * @see org.onap.policy.apex.model.basicmodel.dao.ApexDao#size(java.lang.Class) */ @Override - public long size(final Class aClass) { - if (aClass == null) { + public long size(final Class someClass) { + if (someClass == null) { return 0; } final EntityManager mg = getEntityManager(); long size = 0; try { - size = mg.createQuery("SELECT COUNT(c) FROM " + aClass.getSimpleName() + " c", Long.class) - .getSingleResult(); + size = mg.createQuery("SELECT COUNT(c) FROM " + someClass.getSimpleName() + " c", Long.class) + .getSingleResult(); } finally { mg.close(); } diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/impl/package-info.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/impl/package-info.java index 12e854f26..5d585c247 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/impl/package-info.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/impl/package-info.java @@ -19,7 +19,8 @@ */ /** - * Contains a default DAO implementation for APEX {@link org.onap.policy.apex.model.basicmodel.concepts.AxConcept} classes that uses javax persistence. + * Contains a default DAO implementation for APEX {@link org.onap.policy.apex.model.basicmodel.concepts.AxConcept} + * classes that uses javax persistence. * * @author Liam Fallon (liam.fallon@ericsson.com) */ diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/package-info.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/package-info.java index fe551b87a..505e4023a 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/package-info.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/dao/package-info.java @@ -20,8 +20,8 @@ /** * Defines and implements the Data Access Object (DAO) that allows Apex - * {@link org.onap.policy.apex.model.basicmodel.concepts.AxConcept} concepts to be read from and written to databases over - * JDBC. + * {@link org.onap.policy.apex.model.basicmodel.concepts.AxConcept} concepts to be read from and written to databases + * over JDBC. * * @author Liam Fallon (liam.fallon@ericsson.com) */ diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelCreator.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelCreator.java index 82a808c60..a33e1bf1a 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelCreator.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelCreator.java @@ -23,7 +23,8 @@ package org.onap.policy.apex.model.basicmodel.handling; import org.onap.policy.apex.model.basicmodel.concepts.AxModel; /** - * This interface is implemented by factories that create Apex models. It is mainly used by unit test classes that generate Apex models for test purposes. + * This interface is implemented by factories that create Apex models. It is mainly used by unit test classes that + * generate Apex models for test purposes. * * @author Liam Fallon (liam.fallon@ericsson.com) * @param the type of Apex model to create, must be a sub class of {@link AxModel} diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelException.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelException.java index 8964a5bc2..17eb2639d 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelException.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelException.java @@ -43,9 +43,9 @@ public class ApexModelException extends ApexException { * Instantiates a new apex model handling exception. * * @param message the message - * @param e the e + * @param exception the exception */ - public ApexModelException(final String message, final Exception e) { - super(message, e); + public ApexModelException(final String message, final Exception exception) { + super(message, exception); } } diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelFileWriter.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelFileWriter.java index 2312b88db..aead4cb2b 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelFileWriter.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelFileWriter.java @@ -57,8 +57,8 @@ public class ApexModelFileWriter { * @param modelFileName The name of the file to write to * @throws ApexException thrown on errors */ - public void apexModelWriteXMLFile(final M model, final Class rootModelClass, final String modelFileName) - throws ApexException { + public void apexModelWriteXmlFile(final M model, final Class rootModelClass, final String modelFileName) + throws ApexException { LOGGER.debug("running apexModelWriteXMLFile . . ."); final ApexModelWriter modelWriter = new ApexModelWriter<>(rootModelClass); @@ -80,8 +80,8 @@ public class ApexModelFileWriter { * @param modelFileName The name of the file to write to * @throws ApexException thrown on errors */ - public void apexModelWriteJSONFile(final M model, final Class rootModelClass, final String modelFileName) - throws ApexException { + public void apexModelWriteJsonFile(final M model, final Class rootModelClass, final String modelFileName) + throws ApexException { LOGGER.debug("running apexModelWriteJSONFile . . ."); final ApexModelWriter modelWriter = new ApexModelWriter<>(rootModelClass); @@ -119,7 +119,8 @@ public class ApexModelFileWriter { * @param modelFileName the file name of the file to write to * @throws ApexException on exceptions writing the model */ - private void writeModelFile(final M model, final ApexModelWriter modelWriter, final String modelFileName) throws ApexException { + private void writeModelFile(final M model, final ApexModelWriter modelWriter, final String modelFileName) + throws ApexException { final File modelFile = new File(modelFileName); if (!modelFile.getParentFile().exists() && !modelFile.getParentFile().mkdirs()) { LOGGER.warn("could not create directory " + modelFile.getParentFile()); @@ -130,8 +131,7 @@ public class ApexModelFileWriter { final FileOutputStream fileOutputStream = new FileOutputStream(modelFile); modelWriter.write(model, fileOutputStream); fileOutputStream.close(); - } - catch (final Exception e) { + } catch (final Exception e) { LOGGER.warn("error processing file " + modelFile.getAbsolutePath(), e); throw new ApexException("error processing file " + modelFile.getAbsolutePath(), e); } diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelReader.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelReader.java index 6ca9c03d8..ce2c9fc56 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelReader.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelReader.java @@ -59,8 +59,10 @@ public class ApexModelReader { private static final XLogger LOGGER = XLoggerFactory.getXLogger(ApexModelReader.class); // Regular expressions for checking input types - private static final String XML_INPUT_TYPE_REGEXP = "^\\s*<\\?xml.*>\\s*"; // (starts with - private static final String JSON_INPUT_TYPE_REGEXP = "^\\s*[\\(\\{\\[][\\s+\\S]*[\\)\\}\\]]"; // starts with some kind of bracket [ or ( + // (starts with + private static final String XML_INPUT_TYPE_REGEXP = "^\\s*<\\?xml.*>\\s*"; + // starts with some kind of bracket [ or ( + private static final String JSON_INPUT_TYPE_REGEXP = "^\\s*[\\(\\{\\[][\\s+\\S]*[\\)\\}\\]]"; // or {, then has something, then has // and has a close bracket @@ -119,8 +121,9 @@ public class ApexModelReader { if (schemaFileName != null) { try { // Set the concept schema - final URL schemaURL = ResourceUtils.getUrlResource(schemaFileName); - final Schema apexConceptSchema = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI).newSchema(schemaURL); + final URL schemaUrl = ResourceUtils.getUrlResource(schemaFileName); + final Schema apexConceptSchema = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI) + .newSchema(schemaUrl); unmarshaller.setSchema(apexConceptSchema); } catch (final Exception e) { diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelSaver.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelSaver.java index 16ea1f3fa..4f3008f04 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelSaver.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelSaver.java @@ -45,13 +45,13 @@ public class ApexModelSaver { private final String writePath; /** - * Constructor, specifies the type of the Apex model (a sub class of {@link AxModel}), the model to write, and the path of a directory to which to write the - * model. + * Constructor, specifies the type of the Apex model (a sub class of {@link AxModel}), the model to write, and the + * path of a directory to which to write the model. * * @param rootModelClass the class of the model, a sub class of {@link AxModel} * @param model the model to write, an instance of a sub class of {@link AxModel} - * @param writePath the directory to which models will be written. The name of the written model will be the Model Name for its key with the suffix - * {@code .xml} or {@code .json}. + * @param writePath the directory to which models will be written. The name of the written model will be the Model + * Name for its key with the suffix {@code .xml} or {@code .json}. */ public ApexModelSaver(final Class rootModelClass, final M model, final String writePath) { Assertions.argumentNotNull(rootModelClass, "argument rootModelClass may not be null"); @@ -68,12 +68,12 @@ public class ApexModelSaver { * * @throws ApexException on errors writing the Apex model */ - public void apexModelWriteXML() throws ApexException { + public void apexModelWriteXml() throws ApexException { LOGGER.debug("running apexModelWriteXML . . ."); // Write the file to disk final File xmlFile = new File(writePath + File.separatorChar + model.getKey().getName() + ".xml"); - new ApexModelFileWriter(true).apexModelWriteXMLFile(model, rootModelClass, xmlFile.getPath()); + new ApexModelFileWriter(true).apexModelWriteXmlFile(model, rootModelClass, xmlFile.getPath()); LOGGER.debug("ran apexModelWriteXML"); } @@ -83,12 +83,12 @@ public class ApexModelSaver { * * @throws ApexException on errors writing the Apex model */ - public void apexModelWriteJSON() throws ApexException { + public void apexModelWriteJson() throws ApexException { LOGGER.debug("running apexModelWriteJSON . . ."); // Write the file to disk final File jsonFile = new File(writePath + File.separatorChar + model.getKey().getName() + ".json"); - new ApexModelFileWriter(true).apexModelWriteJSONFile(model, rootModelClass, jsonFile.getPath()); + new ApexModelFileWriter(true).apexModelWriteJsonFile(model, rootModelClass, jsonFile.getPath()); LOGGER.debug("ran apexModelWriteJSON"); } diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelStringWriter.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelStringWriter.java index 3d2e50b38..92a956bde 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelStringWriter.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelStringWriter.java @@ -58,13 +58,13 @@ public class ApexModelStringWriter { * @return The string with the concept * @throws ApexException thrown on errors */ - public String writeString(final C concept, final Class rootConceptClass, final boolean jsonFlag) throws ApexException { + public String writeString(final C concept, final Class rootConceptClass, final boolean jsonFlag) + throws ApexException { Assertions.argumentNotNull(concept, "concept may not be null"); - + if (jsonFlag) { - return writeJSONString(concept, rootConceptClass); - } - else { + return writeJsonString(concept, rootConceptClass); + } else { return concept.toString(); } } @@ -77,7 +77,7 @@ public class ApexModelStringWriter { * @return The string with the concept * @throws ApexException thrown on errors */ - public String writeXMLString(final C concept, final Class rootConceptClass) throws ApexException { + public String writeXmlString(final C concept, final Class rootConceptClass) throws ApexException { LOGGER.debug("running writeXMLString . . ."); final ApexModelWriter conceptWriter = new ApexModelWriter<>(rootConceptClass); @@ -90,8 +90,7 @@ public class ApexModelStringWriter { try { conceptWriter.write(concept, baOutputStream); baOutputStream.close(); - } - catch (final Exception e) { + } catch (final Exception e) { LOGGER.warn("error writing XML string", e); throw new ApexException("error writing XML string", e); } @@ -108,7 +107,7 @@ public class ApexModelStringWriter { * @return The string with the concept * @throws ApexException thrown on errors */ - public String writeJSONString(final C concept, final Class rootConceptClass) throws ApexException { + public String writeJsonString(final C concept, final Class rootConceptClass) throws ApexException { LOGGER.debug("running writeJSONString . . ."); final ApexModelWriter conceptWriter = new ApexModelWriter<>(rootConceptClass); @@ -119,8 +118,7 @@ public class ApexModelStringWriter { try { conceptWriter.write(concept, baOutputStream); baOutputStream.close(); - } - catch (final Exception e) { + } catch (final Exception e) { LOGGER.warn("error writing JSON string", e); throw new ApexException("error writing JSON string", e); } diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelWriter.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelWriter.java index 2bea92cc6..977a8e7c6 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelWriter.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexModelWriter.java @@ -67,7 +67,7 @@ public class ApexModelWriter { private boolean jsonOutput = false; // The list of fields to output as CDATA - private final Set cDataFieldSet = new TreeSet<>(); + private final Set cdataFieldSet = new TreeSet<>(); // The Marshaller for the Apex concepts private Marshaller marshaller = null; @@ -104,7 +104,7 @@ public class ApexModelWriter { * @return the set of fields */ public Set getCDataFieldSet() { - return cDataFieldSet; + return cdataFieldSet; } /** @@ -176,14 +176,14 @@ public class ApexModelWriter { LOGGER.debug(validationResult.toString()); if (!validationResult.isValid()) { LOGGER.warn(validationResult.toString()); - throw new ApexModelException("Apex concept xml (" + concept.getKey().getID() + ") validation failed"); + throw new ApexModelException("Apex concept xml (" + concept.getKey().getId() + ") validation failed"); } } if (jsonOutput) { - writeJSON(concept, apexConceptWriter); + writeJson(concept, apexConceptWriter); } else { - writeXML(concept, apexConceptWriter); + writeXml(concept, apexConceptWriter); } } @@ -194,7 +194,7 @@ public class ApexModelWriter { * @param apexConceptWriter the writer to write to * @throws ApexModelException on validation or writing exceptions */ - private void writeXML(final C concept, final Writer apexConceptWriter) throws ApexModelException { + private void writeXml(final C concept, final Writer apexConceptWriter) throws ApexModelException { Assertions.argumentNotNull(concept, CONCEPT_MAY_NOT_BE_NULL); LOGGER.debug("writing Apex concept XML . . ."); @@ -212,7 +212,7 @@ public class ApexModelWriter { // Convert the cDataFieldSet into a space delimited string domTransformer.setOutputProperty(OutputKeys.CDATA_SECTION_ELEMENTS, - cDataFieldSet.toString().replaceAll("[\\[\\]\\,]", " ")); + cdataFieldSet.toString().replaceAll("[\\[\\]\\,]", " ")); domTransformer.transform(new DOMSource(document), new StreamResult(apexConceptWriter)); } catch (JAXBException | TransformerException | ParserConfigurationException e) { LOGGER.warn("Unable to marshal Apex concept XML", e); @@ -245,7 +245,7 @@ public class ApexModelWriter { * @param apexConceptWriter the writer to write to * @throws ApexModelException on validation or writing exceptions */ - private void writeJSON(final C concept, final Writer apexConceptWriter) throws ApexModelException { + private void writeJson(final C concept, final Writer apexConceptWriter) throws ApexModelException { Assertions.argumentNotNull(concept, CONCEPT_MAY_NOT_BE_NULL); LOGGER.debug("writing Apex concept JSON . . ."); diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexSchemaGenerator.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexSchemaGenerator.java index 6e17ab94d..46e30bf10 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexSchemaGenerator.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/ApexSchemaGenerator.java @@ -53,20 +53,17 @@ public class ApexSchemaGenerator { if (args.length == 1) { printStream = System.out; - } - else if (args.length == 2) { + } else if (args.length == 2) { final File schemaFile = new File(args[1]); try { schemaFile.getParentFile().mkdirs(); printStream = new PrintStream(schemaFile); - } - catch (final Exception e) { + } catch (final Exception e) { LOGGER.error("error on Apex schema output", e); return; } - } - else { + } else { LOGGER.error("usage: ApexSchemaGenerator apex-root-class [schema-file-name]"); return; } @@ -90,12 +87,10 @@ public class ApexSchemaGenerator { JAXBContext jaxbContext; try { jaxbContext = JAXBContext.newInstance(Class.forName(rootClassName)); - } - catch (final ClassNotFoundException e) { + } catch (final ClassNotFoundException e) { LOGGER.error("could not create JAXB context, root class " + rootClassName + " not found", e); return null; - } - catch (final JAXBException e) { + } catch (final JAXBException e) { LOGGER.error("could not create JAXB context", e); return null; } @@ -103,8 +98,7 @@ public class ApexSchemaGenerator { final ApexSchemaOutputResolver sor = new ApexSchemaOutputResolver(); try { jaxbContext.generateSchema(sor); - } - catch (final IOException e) { + } catch (final IOException e) { LOGGER.error("error generating the Apex schema (XSD) file", e); return null; } @@ -116,22 +110,26 @@ public class ApexSchemaGenerator { } /** - * There is a bug in schema generation that does not specify the elements from Java Maps as being unqualified. This method "hacks" those - * elements in the schema to fix this, the elements being {@code entry}, {@code key}, and {@code value} + * There is a bug in schema generation that does not specify the elements from Java Maps as being unqualified. This + * method "hacks" those elements in the schema to fix this, the elements being {@code entry}, {@code key}, and + * {@code value} * * @param schemaString The schema in which elements should be fixed * @return the string */ private String fixForUnqualifiedBug(final String schemaString) { // Fix the "entry" element - String newSchemaString = schemaString.replaceAll("", - ""); + String newSchemaString = schemaString.replaceAll( + "", + ""); // Fix the "key" element - newSchemaString = newSchemaString.replaceAll("The reason for having a model service is to avoid having to pass concept and model definitions down long call + * chains in modules such as the Apex engine and editor. The model service makes the model and concept definitions + * available statically. * - * Note that the use of the model service means that only a single Apex model of a particular type may exist in Apex (particularly the engine) at any time. Of - * course the model in a JVM can be changed at any time provided all users of the model are stopped and restrted in an orderly manner. + *

Note that the use of the model service means that only a single Apex model of a particular type may exist in + * Apex (particularly the engine) at any time. Of course the model in a JVM can be changed at any time provided all + * users of the model are stopped and restarted in an orderly manner. * * @author Liam Fallon (liam.fallon@ericsson.com) */ @@ -80,7 +82,8 @@ public abstract class ModelService { final M model = (M) modelMap.get(modelClass); if (model == null) { - throw new ApexRuntimeException("Model for " + modelClass.getCanonicalName() + " not found in model service"); + throw new ApexRuntimeException( + "Model for " + modelClass.getCanonicalName() + " not found in model service"); } return model; diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/test/TestApexModel.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/test/TestApexModel.java index 356afd723..81b3373e1 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/test/TestApexModel.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/test/TestApexModel.java @@ -30,7 +30,7 @@ import org.onap.policy.apex.model.basicmodel.concepts.AxModel; import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult; import org.onap.policy.apex.model.basicmodel.dao.ApexDao; import org.onap.policy.apex.model.basicmodel.dao.ApexDaoFactory; -import org.onap.policy.apex.model.basicmodel.dao.DAOParameters; +import org.onap.policy.apex.model.basicmodel.dao.DaoParameters; import org.onap.policy.apex.model.basicmodel.handling.ApexModelFileWriter; import org.onap.policy.apex.model.basicmodel.handling.ApexModelReader; import org.onap.policy.apex.model.basicmodel.handling.ApexModelWriter; @@ -39,19 +39,19 @@ import org.slf4j.ext.XLogger; import org.slf4j.ext.XLoggerFactory; /** - * This class tests reading and writing of Apex models to file and to a database using JPA. It also tests validation of Apex models. This class is designed for - * use in unit tests in modules that define Apex models. + * This class tests reading and writing of Apex models to file and to a database using JPA. It also tests validation of + * Apex models. This class is designed for use in unit tests in modules that define Apex models. * * @author Liam Fallon (liam.fallon@ericsson.com) * @param the generic type */ public class TestApexModel { private static final String MODEL_IS_INVALID = "model is invalid "; - private static final String ERROR_PROCESSING_FILE = "error processing file "; - private static final String TEST_MODEL_DOES_NOT_EQUAL_MODEL_READ_FROM_XML_FILE = "test model does not equal model read from XML file "; - private static final String ERROR_CREATING_TEMPORARY_FILE_FOR_APEX_MODEL = "error creating temporary file for Apex model"; + private static final String ERROR_PROCESSING_FILE = "error processing file "; + private static final String TEST_MODEL_UNEQUAL_STR = "test model does not equal model read from XML file "; + private static final String TEMP_FILE_CREATE_ERR_STR = "error creating temporary file for Apex model"; - private static final XLogger LOGGER = XLoggerFactory.getXLogger(TestApexModel.class); + private static final XLogger LOGGER = XLoggerFactory.getXLogger(TestApexModel.class); // The root model class that specifies the root to import and export from private final Class rootModelClass; @@ -60,8 +60,8 @@ public class TestApexModel { private TestApexModelCreator modelCreator = null; /** - * Constructor, defines the subclass of {@link AxModel} that is being tested and the {@link TestApexModelCreator} object that is used to generate Apex - * models. + * Constructor, defines the subclass of {@link AxModel} that is being tested and the {@link TestApexModelCreator} + * object that is used to generate Apex models. * * @param rootModelClass the Apex model class, a sub class of {@link AxModel} * @param modelCreator the @link TestApexModelCreator} that will generate Apex models of various types for testing @@ -85,36 +85,34 @@ public class TestApexModel { * * @throws ApexException on write/read errors */ - public final void testApexModelWriteReadXML() throws ApexException { + public final void testApexModelWriteReadXml() throws ApexException { LOGGER.debug("running testApexModelWriteReadXML . . ."); final M model = modelCreator.getModel(); // Write the file to disk File xmlFile; - + try { xmlFile = File.createTempFile("ApexModel", ".xml"); xmlFile.deleteOnExit(); + } catch (final Exception e) { + LOGGER.warn(TEMP_FILE_CREATE_ERR_STR, e); + throw new ApexException(TEMP_FILE_CREATE_ERR_STR, e); } - catch (final Exception e) { - LOGGER.warn(ERROR_CREATING_TEMPORARY_FILE_FOR_APEX_MODEL, e); - throw new ApexException(ERROR_CREATING_TEMPORARY_FILE_FOR_APEX_MODEL, e); - } - new ApexModelFileWriter(true).apexModelWriteXMLFile(model, rootModelClass, xmlFile.getPath()); + new ApexModelFileWriter(true).apexModelWriteXmlFile(model, rootModelClass, xmlFile.getPath()); // Read the file from disk final ApexModelReader modelReader = new ApexModelReader<>(rootModelClass); try { - final URL apexModelURL = ResourceUtils.getLocalFile(xmlFile.getAbsolutePath()); - final M fileModel = modelReader.read(apexModelURL.openStream()); + final URL apexModelUrl = ResourceUtils.getLocalFile(xmlFile.getAbsolutePath()); + final M fileModel = modelReader.read(apexModelUrl.openStream()); if (!model.equals(fileModel)) { - LOGGER.warn(TEST_MODEL_DOES_NOT_EQUAL_MODEL_READ_FROM_XML_FILE + xmlFile.getAbsolutePath()); - throw new ApexException(TEST_MODEL_DOES_NOT_EQUAL_MODEL_READ_FROM_XML_FILE + xmlFile.getAbsolutePath()); + LOGGER.warn(TEST_MODEL_UNEQUAL_STR + xmlFile.getAbsolutePath()); + throw new ApexException(TEST_MODEL_UNEQUAL_STR + xmlFile.getAbsolutePath()); } - } - catch (final Exception e) { + } catch (final Exception e) { LOGGER.warn(ERROR_PROCESSING_FILE + xmlFile.getAbsolutePath(), e); throw new ApexException(ERROR_PROCESSING_FILE + xmlFile.getAbsolutePath(), e); } @@ -141,7 +139,7 @@ public class TestApexModel { * * @throws ApexException on write/read errors */ - public final void testApexModelWriteReadJSON() throws ApexException { + public final void testApexModelWriteReadJson() throws ApexException { LOGGER.debug("running testApexModelWriteReadJSON . . ."); final M model = modelCreator.getModel(); @@ -151,25 +149,24 @@ public class TestApexModel { try { jsonFile = File.createTempFile("ApexModel", ".xml"); jsonFile.deleteOnExit(); + } catch (final Exception e) { + LOGGER.warn(TEMP_FILE_CREATE_ERR_STR, e); + throw new ApexException(TEMP_FILE_CREATE_ERR_STR, e); } - catch (final Exception e) { - LOGGER.warn(ERROR_CREATING_TEMPORARY_FILE_FOR_APEX_MODEL, e); - throw new ApexException(ERROR_CREATING_TEMPORARY_FILE_FOR_APEX_MODEL, e); - } - new ApexModelFileWriter(true).apexModelWriteJSONFile(model, rootModelClass, jsonFile.getPath()); + new ApexModelFileWriter(true).apexModelWriteJsonFile(model, rootModelClass, jsonFile.getPath()); // Read the file from disk final ApexModelReader modelReader = new ApexModelReader<>(rootModelClass); try { - final URL apexModelURL = ResourceUtils.getLocalFile(jsonFile.getAbsolutePath()); - final M fileModel = modelReader.read(apexModelURL.openStream()); + final URL apexModelUrl = ResourceUtils.getLocalFile(jsonFile.getAbsolutePath()); + final M fileModel = modelReader.read(apexModelUrl.openStream()); if (!model.equals(fileModel)) { - LOGGER.warn(TEST_MODEL_DOES_NOT_EQUAL_MODEL_READ_FROM_XML_FILE + jsonFile.getAbsolutePath()); - throw new ApexException(TEST_MODEL_DOES_NOT_EQUAL_MODEL_READ_FROM_XML_FILE + jsonFile.getAbsolutePath()); + LOGGER.warn(TEST_MODEL_UNEQUAL_STR + jsonFile.getAbsolutePath()); + throw new ApexException( + TEST_MODEL_UNEQUAL_STR + jsonFile.getAbsolutePath()); } - } - catch (final Exception e) { + } catch (final Exception e) { LOGGER.warn(ERROR_PROCESSING_FILE + jsonFile.getAbsolutePath(), e); throw new ApexException(ERROR_PROCESSING_FILE + jsonFile.getAbsolutePath(), e); } @@ -195,7 +192,7 @@ public class TestApexModel { * @param daoParameters the DAO parameters to use for JPA/JDBC * @throws ApexException thrown on errors writing or reading the model to database */ - public final void testApexModelWriteReadJPA(final DAOParameters daoParameters) throws ApexException { + public final void testApexModelWriteReadJpa(final DaoParameters daoParameters) throws ApexException { LOGGER.debug("running testApexModelWriteReadJPA . . ."); final M model = modelCreator.getModel(); @@ -204,10 +201,10 @@ public class TestApexModel { apexDao.init(daoParameters); apexDao.create(model); - final M dbJPAModel = apexDao.get(rootModelClass, model.getKey()); + final M dbJpaModel = apexDao.get(rootModelClass, model.getKey()); apexDao.close(); - if (!model.equals(dbJPAModel)) { + if (!model.equals(dbJpaModel)) { LOGGER.warn("test model does not equal model written and read using generic JPA"); throw new ApexException("test model does not equal model written and read using generic JPA"); } diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/test/TestApexModelCreator.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/test/TestApexModelCreator.java index 980748926..65441a33c 100644 --- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/test/TestApexModelCreator.java +++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/test/TestApexModelCreator.java @@ -24,8 +24,8 @@ import org.onap.policy.apex.model.basicmodel.concepts.AxModel; import org.onap.policy.apex.model.basicmodel.handling.ApexModelCreator; /** - * The Interface TestApexModelCreator is used to create models for Apex model tests. It is mainly used by unit tests for Apex domain models so that - * developers can write test Java programs to create models. + * The Interface TestApexModelCreator is used to create models for Apex model tests. It is mainly used by unit tests for + * Apex domain models so that developers can write test Java programs to create models. * * @author Liam Fallon (liam.fallon@ericsson.com) * @param the generic type diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/AxKeyTest.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/AxKeyTest.java index 6ac46b14e..ea09cc69d 100644 --- a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/AxKeyTest.java +++ b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/AxKeyTest.java @@ -29,91 +29,99 @@ import static org.junit.Assert.fail; import org.junit.Test; import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey; import org.onap.policy.apex.model.basicmodel.concepts.AxKey; +import org.onap.policy.apex.model.basicmodel.concepts.AxKey.Compatibility; import org.onap.policy.apex.model.basicmodel.concepts.AxReferenceKey; import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult; -import org.onap.policy.apex.model.basicmodel.concepts.AxKey.Compatibility; -/** - * @author Liam Fallon (liam.fallon@ericsson.com) - */ public class AxKeyTest { @Test public void testArtifactKey() { - AxArtifactKey aKey0 = new AxArtifactKey(); - AxArtifactKey aKey1 = new AxArtifactKey("name", "0.0.1"); - AxArtifactKey aKey2 = new AxArtifactKey(aKey1); - AxArtifactKey aKey3 = new AxArtifactKey(aKey1.getID()); - AxArtifactKey aKey4 = new AxArtifactKey(aKey1); - AxArtifactKey aKey5 = new AxArtifactKey(aKey1); - AxArtifactKey aKey6 = new AxArtifactKey(aKey1); - try { new AxArtifactKey("some bad key id"); fail("This test should throw an exception"); + } catch (IllegalArgumentException e) { + assertEquals("parameter \"id\": value \"some bad key id\", " + + "does not match regular expression \"[A-Za-z0-9\\-_\\.]+:[0-9].[0-9].[0-9]\"", + e.getMessage()); } - catch (IllegalArgumentException e) { - assertEquals("parameter \"id\": value \"some bad key id\", does not match regular expression \"[A-Za-z0-9\\-_\\.]+:[0-9].[0-9].[0-9]\"", e.getMessage()); - } - - assertEquals(AxArtifactKey.getNullKey(), aKey0); - assertEquals(aKey1, aKey2); - assertEquals(aKey1, aKey3); - - assertEquals(aKey2, aKey1.getKey()); - assertEquals(1, aKey1.getKeys().size()); - - aKey0.setName("zero"); - aKey0.setVersion("0.0.2"); - aKey3.setVersion("0.0.2"); - aKey4.setVersion("0.1.2"); - aKey5.setVersion("1.2.2"); - aKey6.setVersion("3"); - - assertEquals(Compatibility.DIFFERENT, aKey0.getCompatibility(new AxReferenceKey())); - assertEquals(Compatibility.DIFFERENT, aKey0.getCompatibility(aKey1)); - assertEquals(Compatibility.IDENTICAL, aKey2.getCompatibility(aKey1)); - assertEquals(Compatibility.PATCH, aKey3.getCompatibility(aKey1)); - assertEquals(Compatibility.MINOR, aKey4.getCompatibility(aKey1)); - assertEquals(Compatibility.MAJOR, aKey5.getCompatibility(aKey1)); - assertEquals(Compatibility.MAJOR, aKey6.getCompatibility(aKey1)); - - assertTrue(aKey1.isCompatible(aKey2)); - assertTrue(aKey1.isCompatible(aKey3)); - assertTrue(aKey1.isCompatible(aKey4)); - assertFalse(aKey1.isCompatible(aKey0)); - assertFalse(aKey1.isCompatible(aKey5)); - assertFalse(aKey1.isCompatible(new AxReferenceKey())); - - assertEquals(AxValidationResult.ValidationResult.VALID, aKey0.validate(new AxValidationResult()).getValidationResult()); - assertEquals(AxValidationResult.ValidationResult.VALID, aKey1.validate(new AxValidationResult()).getValidationResult()); - assertEquals(AxValidationResult.ValidationResult.VALID, aKey2.validate(new AxValidationResult()).getValidationResult()); - assertEquals(AxValidationResult.ValidationResult.VALID, aKey3.validate(new AxValidationResult()).getValidationResult()); - assertEquals(AxValidationResult.ValidationResult.VALID, aKey4.validate(new AxValidationResult()).getValidationResult()); - assertEquals(AxValidationResult.ValidationResult.VALID, aKey5.validate(new AxValidationResult()).getValidationResult()); - assertEquals(AxValidationResult.ValidationResult.VALID, aKey6.validate(new AxValidationResult()).getValidationResult()); - - aKey0.clean(); - assertNotNull(aKey0.toString()); - - AxArtifactKey aKey7 = new AxArtifactKey(aKey1); - assertEquals(150332875, aKey7.hashCode()); - assertEquals(0, aKey7.compareTo(aKey1)); - assertEquals(-12, aKey7.compareTo(aKey0)); - + + AxArtifactKey someKey0 = new AxArtifactKey(); + assertEquals(AxArtifactKey.getNullKey(), someKey0); + + AxArtifactKey someKey1 = new AxArtifactKey("name", "0.0.1"); + AxArtifactKey someKey2 = new AxArtifactKey(someKey1); + AxArtifactKey someKey3 = new AxArtifactKey(someKey1.getId()); + assertEquals(someKey1, someKey2); + assertEquals(someKey1, someKey3); + + assertEquals(someKey2, someKey1.getKey()); + assertEquals(1, someKey1.getKeys().size()); + + someKey0.setName("zero"); + someKey0.setVersion("0.0.2"); + + someKey3.setVersion("0.0.2"); + + AxArtifactKey someKey4 = new AxArtifactKey(someKey1); + someKey4.setVersion("0.1.2"); + + AxArtifactKey someKey5 = new AxArtifactKey(someKey1); + someKey5.setVersion("1.2.2"); + + AxArtifactKey someKey6 = new AxArtifactKey(someKey1); + someKey6.setVersion("3"); + + assertEquals(Compatibility.DIFFERENT, someKey0.getCompatibility(new AxReferenceKey())); + assertEquals(Compatibility.DIFFERENT, someKey0.getCompatibility(someKey1)); + assertEquals(Compatibility.IDENTICAL, someKey2.getCompatibility(someKey1)); + assertEquals(Compatibility.PATCH, someKey3.getCompatibility(someKey1)); + assertEquals(Compatibility.MINOR, someKey4.getCompatibility(someKey1)); + assertEquals(Compatibility.MAJOR, someKey5.getCompatibility(someKey1)); + assertEquals(Compatibility.MAJOR, someKey6.getCompatibility(someKey1)); + + assertTrue(someKey1.isCompatible(someKey2)); + assertTrue(someKey1.isCompatible(someKey3)); + assertTrue(someKey1.isCompatible(someKey4)); + assertFalse(someKey1.isCompatible(someKey0)); + assertFalse(someKey1.isCompatible(someKey5)); + assertFalse(someKey1.isCompatible(new AxReferenceKey())); + + assertEquals(AxValidationResult.ValidationResult.VALID, + someKey0.validate(new AxValidationResult()).getValidationResult()); + assertEquals(AxValidationResult.ValidationResult.VALID, + someKey1.validate(new AxValidationResult()).getValidationResult()); + assertEquals(AxValidationResult.ValidationResult.VALID, + someKey2.validate(new AxValidationResult()).getValidationResult()); + assertEquals(AxValidationResult.ValidationResult.VALID, + someKey3.validate(new AxValidationResult()).getValidationResult()); + assertEquals(AxValidationResult.ValidationResult.VALID, + someKey4.validate(new AxValidationResult()).getValidationResult()); + assertEquals(AxValidationResult.ValidationResult.VALID, + someKey5.validate(new AxValidationResult()).getValidationResult()); + assertEquals(AxValidationResult.ValidationResult.VALID, + someKey6.validate(new AxValidationResult()).getValidationResult()); + + someKey0.clean(); + assertNotNull(someKey0.toString()); + + AxArtifactKey someKey7 = new AxArtifactKey(someKey1); + assertEquals(150332875, someKey7.hashCode()); + assertEquals(0, someKey7.compareTo(someKey1)); + assertEquals(-12, someKey7.compareTo(someKey0)); + try { - aKey0.compareTo(null); - } - catch (IllegalArgumentException e) { + someKey0.compareTo(null); + } catch (IllegalArgumentException e) { assertEquals("comparison object may not be null", e.getMessage()); } - - assertEquals(0, aKey0.compareTo(aKey0)); - assertEquals(353602977, aKey0.compareTo(new AxReferenceKey())); - - assertFalse(aKey0.equals(null)); - assertTrue(aKey0.equals(aKey0)); - assertFalse(((AxKey)aKey0).equals(new AxReferenceKey())); + + assertEquals(0, someKey0.compareTo(someKey0)); + assertEquals(353602977, someKey0.compareTo(new AxReferenceKey())); + + assertFalse(someKey0.equals(null)); + assertTrue(someKey0.equals(someKey0)); + assertFalse(((AxKey) someKey0).equals(new AxReferenceKey())); } } diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/TestAxKeyInfo.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/TestAxKeyInfo.java index 8368634bf..f615d9db9 100644 --- a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/TestAxKeyInfo.java +++ b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/TestAxKeyInfo.java @@ -33,9 +33,6 @@ import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey; import org.onap.policy.apex.model.basicmodel.concepts.AxKeyInfo; import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult; -/** - * @author Liam Fallon (liam.fallon@ericsson.com) - */ public class TestAxKeyInfo { @Test @@ -46,23 +43,24 @@ public class TestAxKeyInfo { AxKeyInfo testKeyInfo = new AxKeyInfo(); testKeyInfo.setKey((new AxArtifactKey("PN", "0.0.1"))); - assertEquals("PN:0.0.1", testKeyInfo.getKey().getID()); + assertEquals("PN:0.0.1", testKeyInfo.getKey().getId()); AxArtifactKey key = new AxArtifactKey("key", "0.0.1"); testKeyInfo.setKey(key); assertEquals(key, testKeyInfo.getKey()); - + UUID uuid = UUID.randomUUID(); testKeyInfo.setUuid(uuid); - assertEquals(uuid, testKeyInfo.getUUID()); + assertEquals(uuid, testKeyInfo.getUuid()); testKeyInfo.setDescription("Key Description"); assertEquals("Key Description", testKeyInfo.getDescription()); - + AxKeyInfo clonedReferenceKey = new AxKeyInfo(testKeyInfo); - assertTrue(clonedReferenceKey.toString().startsWith("AxKeyInfo:(artifactId=AxArtifactKey:(name=key,version=0.0.1),uuid=")); - + assertTrue(clonedReferenceKey.toString() + .startsWith("AxKeyInfo:(artifactId=AxArtifactKey:(name=key,version=0.0.1),uuid=")); + assertFalse(testKeyInfo.hashCode() == 0); - + assertTrue(testKeyInfo.equals(testKeyInfo)); assertTrue(testKeyInfo.equals(clonedReferenceKey)); assertFalse(testKeyInfo.equals(null)); @@ -71,7 +69,7 @@ public class TestAxKeyInfo { assertFalse(testKeyInfo.equals(new AxKeyInfo(key, UUID.randomUUID(), "Some Description"))); assertFalse(testKeyInfo.equals(new AxKeyInfo(key, uuid, "Some Description"))); assertTrue(testKeyInfo.equals(new AxKeyInfo(key, uuid, "Key Description"))); - + assertEquals(0, testKeyInfo.compareTo(testKeyInfo)); assertEquals(0, testKeyInfo.compareTo(clonedReferenceKey)); assertNotEquals(0, testKeyInfo.compareTo(null)); @@ -80,28 +78,28 @@ public class TestAxKeyInfo { assertNotEquals(0, testKeyInfo.compareTo(new AxKeyInfo(key, UUID.randomUUID(), "Some Description"))); assertNotEquals(0, testKeyInfo.compareTo(new AxKeyInfo(key, uuid, "Some Description"))); assertEquals(0, testKeyInfo.compareTo(new AxKeyInfo(key, uuid, "Key Description"))); - + assertNotNull(testKeyInfo.getKeys()); - + AxValidationResult result = new AxValidationResult(); result = testKeyInfo.validate(result); assertEquals(AxValidationResult.ValidationResult.VALID, result.getValidationResult()); - + testKeyInfo.setDescription(""); result = testKeyInfo.validate(result); assertEquals(AxValidationResult.ValidationResult.OBSERVATION, result.getValidationResult()); - + testKeyInfo.setUuid(new UUID(0, 0)); result = testKeyInfo.validate(result); assertEquals(AxValidationResult.ValidationResult.WARNING, result.getValidationResult()); - + testKeyInfo.setKey(AxArtifactKey.getNullKey()); result = testKeyInfo.validate(result); assertEquals(AxValidationResult.ValidationResult.INVALID, result.getValidationResult()); - - assertNotNull(AxKeyInfo.generateReproducibleUUID(null)); - assertNotNull(AxKeyInfo.generateReproducibleUUID("SeedString")); - + + assertNotNull(AxKeyInfo.generateReproducibleUuid(null)); + assertNotNull(AxKeyInfo.generateReproducibleUuid("SeedString")); + testKeyInfo.clean(); assertNotNull(testKeyInfo); } diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/TestAxReferenceKey.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/TestAxReferenceKey.java index dbc925d66..79f3984c3 100644 --- a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/TestAxReferenceKey.java +++ b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/TestAxReferenceKey.java @@ -32,9 +32,6 @@ import org.onap.policy.apex.model.basicmodel.concepts.AxKey; import org.onap.policy.apex.model.basicmodel.concepts.AxReferenceKey; import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult; -/** - * @author Liam Fallon (liam.fallon@ericsson.com) - */ public class TestAxReferenceKey { @Test @@ -49,46 +46,47 @@ public class TestAxReferenceKey { assertNotNull(new AxReferenceKey("ParentKeyName", "0.0.1", "ParentLocalName", "LocalName")); assertNotNull(new AxReferenceKey("ParentKeyName:0.0.1:ParentLocalName:LocalName")); assertEquals(AxReferenceKey.getNullKey().getKey(), AxReferenceKey.getNullKey()); - assertEquals("NULL:0.0.0:NULL:NULL", AxReferenceKey.getNullKey().getID()); + assertEquals("NULL:0.0.0:NULL:NULL", AxReferenceKey.getNullKey().getId()); AxReferenceKey testReferenceKey = new AxReferenceKey(); testReferenceKey.setParentArtifactKey(new AxArtifactKey("PN", "0.0.1")); - assertEquals("PN:0.0.1", testReferenceKey.getParentArtifactKey().getID()); - + assertEquals("PN:0.0.1", testReferenceKey.getParentArtifactKey().getId()); + testReferenceKey.setParentReferenceKey(new AxReferenceKey("PN", "0.0.1", "LN")); - assertEquals("PN:0.0.1:NULL:LN", testReferenceKey.getParentReferenceKey().getID()); - + assertEquals("PN:0.0.1:NULL:LN", testReferenceKey.getParentReferenceKey().getId()); + testReferenceKey.setParentKeyName("NPKN"); assertEquals("NPKN", testReferenceKey.getParentKeyName()); - + testReferenceKey.setParentKeyVersion("0.0.1"); assertEquals("0.0.1", testReferenceKey.getParentKeyVersion()); - + testReferenceKey.setParentLocalName("NPKLN"); assertEquals("NPKLN", testReferenceKey.getParentLocalName()); - + testReferenceKey.setLocalName("NLN"); assertEquals("NLN", testReferenceKey.getLocalName()); - + assertFalse(testReferenceKey.isCompatible(AxArtifactKey.getNullKey())); assertFalse(testReferenceKey.isCompatible(AxReferenceKey.getNullKey())); assertTrue(testReferenceKey.isCompatible(testReferenceKey)); - + assertEquals(AxKey.Compatibility.DIFFERENT, testReferenceKey.getCompatibility(AxArtifactKey.getNullKey())); assertEquals(AxKey.Compatibility.DIFFERENT, testReferenceKey.getCompatibility(AxReferenceKey.getNullKey())); assertEquals(AxKey.Compatibility.IDENTICAL, testReferenceKey.getCompatibility(testReferenceKey)); - + AxValidationResult result = new AxValidationResult(); result = testReferenceKey.validate(result); assertEquals(AxValidationResult.ValidationResult.VALID, result.getValidationResult()); - + testReferenceKey.clean(); - + AxReferenceKey clonedReferenceKey = new AxReferenceKey(testReferenceKey); - assertEquals("AxReferenceKey:(parentKeyName=NPKN,parentKeyVersion=0.0.1,parentLocalName=NPKLN,localName=NLN)", clonedReferenceKey.toString()); - + assertEquals("AxReferenceKey:(parentKeyName=NPKN,parentKeyVersion=0.0.1,parentLocalName=NPKLN,localName=NLN)", + clonedReferenceKey.toString()); + assertFalse(testReferenceKey.hashCode() == 0); - + assertTrue(testReferenceKey.equals(testReferenceKey)); assertTrue(testReferenceKey.equals(clonedReferenceKey)); assertFalse(testReferenceKey.equals("Hello")); @@ -97,7 +95,7 @@ public class TestAxReferenceKey { assertFalse(testReferenceKey.equals(new AxReferenceKey("NPKN", "0.0.1", "PLN", "LN"))); assertFalse(testReferenceKey.equals(new AxReferenceKey("NPKN", "0.0.1", "NPLN", "LN"))); assertTrue(testReferenceKey.equals(new AxReferenceKey("NPKN", "0.0.1", "NPKLN", "NLN"))); - + assertEquals(0, testReferenceKey.compareTo(testReferenceKey)); assertEquals(0, testReferenceKey.compareTo(clonedReferenceKey)); assertNotEquals(0, testReferenceKey.compareTo(new AxArtifactKey())); @@ -106,7 +104,7 @@ public class TestAxReferenceKey { assertNotEquals(0, testReferenceKey.compareTo(new AxReferenceKey("NPKN", "0.0.1", "PLN", "LN"))); assertNotEquals(0, testReferenceKey.compareTo(new AxReferenceKey("NPKN", "0.0.1", "NPLN", "LN"))); assertEquals(0, testReferenceKey.compareTo(new AxReferenceKey("NPKN", "0.0.1", "NPKLN", "NLN"))); - + assertNotNull(testReferenceKey.getKeys()); } } diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/TestEntity.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/TestEntity.java index 6ba380bb8..2667f3d4d 100644 --- a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/TestEntity.java +++ b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/TestEntity.java @@ -47,22 +47,22 @@ public class TestEntity extends AxConcept { protected AxReferenceKey key; private double doubleValue; - + public TestEntity() { this.key = new AxReferenceKey(); this.doubleValue = 0; } - + public TestEntity(Double doubleValue) { this.key = new AxReferenceKey(); this.doubleValue = doubleValue; } - + public TestEntity(AxReferenceKey key, Double doubleValue) { this.key = key; this.doubleValue = doubleValue; } - + public AxReferenceKey getKey() { return key; } @@ -96,7 +96,7 @@ public class TestEntity extends AxConcept { public void clean() { key.clean(); } - + @Override public String toString() { final StringBuilder builder = new StringBuilder(); @@ -107,20 +107,18 @@ public class TestEntity extends AxConcept { @Override public AxConcept copyTo(AxConcept target) { - final Object copyObject = ((target == null) ? new TestEntity(): target); + final Object copyObject = ((target == null) ? new TestEntity() : target); if (copyObject instanceof TestEntity) { final TestEntity copy = ((TestEntity) copyObject); if (this.checkSetKey()) { copy.setKey(new AxReferenceKey(key)); - } - else { + } else { copy.key = null; } copy.doubleValue = doubleValue; return copy; - } - else { - return null; + } else { + return null; } } @@ -134,42 +132,49 @@ public class TestEntity extends AxConcept { @Override public boolean equals(Object obj) { - if (obj == null) + if (obj == null) { return false; - if (this == obj) + } + if (this == obj) { return true; - if (getClass() != obj.getClass()) + } + if (getClass() != obj.getClass()) { return false; + } TestEntity other = (TestEntity) obj; if (key == null) { - if (other.key != null) + if (other.key != null) { return false; + } + } else if (!key.equals(other.key)) { + return false; + } + if (doubleValue != other.doubleValue) { + return false; } - else - if (!key.equals(other.key)) - return false; - if (doubleValue != other.doubleValue) - return false; return true; } - + @Override public int compareTo(AxConcept otherObj) { - if (otherObj == null) + if (otherObj == null) { return -1; - if (this == otherObj) + } + if (this == otherObj) { return 0; + } TestEntity other = (TestEntity) otherObj; if (key == null) { - if (other.key != null) + if (other.key != null) { return 1; + } + } else if (!key.equals(other.key)) { + return key.compareTo(other.key); } - else - if (!key.equals(other.key)) - return key.compareTo(other.key); - if (doubleValue != other.doubleValue) + if (doubleValue != other.doubleValue) { return new Double(doubleValue).compareTo(other.doubleValue); - + } + return 0; } } diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/TestExceptions.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/TestExceptions.java index 1fc5209b0..7a980d5f6 100644 --- a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/TestExceptions.java +++ b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/TestExceptions.java @@ -31,9 +31,6 @@ import org.onap.policy.apex.model.basicmodel.concepts.ApexException; import org.onap.policy.apex.model.basicmodel.concepts.ApexRuntimeException; import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey; -/** - * @author Liam Fallon (liam.fallon@ericsson.com) - */ public class TestExceptions { @Test @@ -42,29 +39,32 @@ public class TestExceptions { assertNotNull(new ApexException("Message", new AxArtifactKey())); assertNotNull(new ApexException("Message", new IOException())); assertNotNull(new ApexException("Message", new IOException(), new AxArtifactKey())); - + AxArtifactKey key = new AxArtifactKey(); ApexException ae = new ApexException("Message", new IOException("IO exception message"), key); assertEquals("Message\ncaused by: Message\ncaused by: IO exception message", ae.getCascadedMessage()); assertEquals(key, ae.getObject()); - + assertNotNull(new ApexRuntimeException("Message")); assertNotNull(new ApexRuntimeException("Message", new AxArtifactKey())); assertNotNull(new ApexRuntimeException("Message", new IOException())); assertNotNull(new ApexRuntimeException("Message", new IOException(), new AxArtifactKey())); - - AxArtifactKey rKey = new AxArtifactKey(); - ApexRuntimeException re = new ApexRuntimeException("Runtime Message", new IOException("IO runtime exception message"), rKey); - assertEquals("Runtime Message\ncaused by: Runtime Message\ncaused by: IO runtime exception message", re.getCascadedMessage()); + + AxArtifactKey rkey = new AxArtifactKey(); + ApexRuntimeException re = new ApexRuntimeException("Runtime Message", + new IOException("IO runtime exception message"), rkey); + assertEquals("Runtime Message\ncaused by: Runtime Message\ncaused by: IO runtime exception message", + re.getCascadedMessage()); assertEquals(key, re.getObject()); - + assertNotNull(new ApexConceptException("Message")); assertNotNull(new ApexConceptException("Message", new IOException())); - - AxArtifactKey cKey = new AxArtifactKey(); - ApexException ace = new ApexException("Concept Message", new IOException("IO concept exception message"), cKey); - assertEquals("Concept Message\ncaused by: Concept Message\ncaused by: IO concept exception message", ace.getCascadedMessage()); - assertEquals(cKey, ace.getObject()); + + AxArtifactKey ckey = new AxArtifactKey(); + ApexException ace = new ApexException("Concept Message", new IOException("IO concept exception message"), ckey); + assertEquals("Concept Message\ncaused by: Concept Message\ncaused by: IO concept exception message", + ace.getCascadedMessage()); + assertEquals(ckey, ace.getObject()); } } diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/TestKeyUse.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/TestKeyUse.java new file mode 100644 index 000000000..6b5346971 --- /dev/null +++ b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/TestKeyUse.java @@ -0,0 +1,82 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2016-2018 Ericsson. All rights reserved. + * ================================================================================ + * 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. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.policy.apex.model.basicmodel.concepts; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertNotEquals; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertTrue; + +import org.junit.Test; +import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey; +import org.onap.policy.apex.model.basicmodel.concepts.AxKey.Compatibility; +import org.onap.policy.apex.model.basicmodel.concepts.AxKeyUse; +import org.onap.policy.apex.model.basicmodel.concepts.AxReferenceKey; +import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult; + +public class TestKeyUse { + + @Test + public void test() { + assertNotNull(new AxKeyUse()); + assertNotNull(new AxKeyUse(new AxArtifactKey())); + assertNotNull(new AxKeyUse(new AxReferenceKey())); + + AxArtifactKey key = new AxArtifactKey("Key", "0.0.1"); + AxKeyUse keyUse = new AxKeyUse(); + keyUse.setKey(key); + assertEquals(key, keyUse.getKey()); + assertEquals("Key:0.0.1", keyUse.getId()); + assertEquals(key, keyUse.getKeys().get(0)); + + assertEquals(Compatibility.IDENTICAL, keyUse.getCompatibility(key)); + assertTrue(keyUse.isCompatible(key)); + + keyUse.clean(); + assertNotNull(keyUse); + + AxValidationResult result = new AxValidationResult(); + result = keyUse.validate(result); + assertNotNull(result); + + assertNotEquals(0, keyUse.hashCode()); + + AxKeyUse clonedKeyUse = new AxKeyUse(keyUse); + assertEquals("AxKeyUse:(usedKey=AxArtifactKey:(name=Key,version=0.0.1))", clonedKeyUse.toString()); + + assertFalse(keyUse.hashCode() == 0); + + assertTrue(keyUse.equals(keyUse)); + assertTrue(keyUse.equals(clonedKeyUse)); + assertFalse(keyUse.equals("Hello")); + assertTrue(keyUse.equals(new AxKeyUse(key))); + + assertEquals(0, keyUse.compareTo(keyUse)); + assertEquals(0, keyUse.compareTo(clonedKeyUse)); + assertNotEquals(0, keyUse.compareTo(new AxArtifactKey())); + assertEquals(0, keyUse.compareTo(new AxKeyUse(key))); + + AxKeyUse keyUseNull = new AxKeyUse(AxArtifactKey.getNullKey()); + AxValidationResult resultNull = new AxValidationResult(); + assertEquals(false, keyUseNull.validate(resultNull).isValid()); + } +} diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/TestValidation.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/TestValidation.java index 93eb78b7c..cfa4d0ded 100644 --- a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/TestValidation.java +++ b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/TestValidation.java @@ -32,9 +32,6 @@ import org.onap.policy.apex.model.basicmodel.concepts.AxValidationMessage; import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult; import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult; -/** - * @author Liam Fallon (liam.fallon@ericsson.com) - */ public class TestValidation { @Test @@ -42,49 +39,53 @@ public class TestValidation { AxValidationResult result = new AxValidationResult(); AxReferenceKey refKey = new AxReferenceKey("PK", "0.0.1", "PLN", "LN"); result = refKey.validate(result); - + assertNotNull(result); - assertTrue(result.isOK()); + assertTrue(result.isOk()); assertTrue(result.isValid()); assertEquals(AxValidationResult.ValidationResult.VALID, result.getValidationResult()); assertNotNull(result.getMessageList()); - - AxValidationMessage vMess0 = new AxValidationMessage(AxArtifactKey.getNullKey(), AxArtifactKey.class, ValidationResult.VALID, "Some message"); - result.addValidationMessage(vMess0); - - assertTrue(result.isOK()); + + AxValidationMessage vmess0 = new AxValidationMessage(AxArtifactKey.getNullKey(), AxArtifactKey.class, + ValidationResult.VALID, "Some message"); + result.addValidationMessage(vmess0); + + assertTrue(result.isOk()); assertTrue(result.isValid()); assertEquals(AxValidationResult.ValidationResult.VALID, result.getValidationResult()); assertNotNull(result.getMessageList()); assertNotNull("hello", result.toString()); - - AxValidationMessage vMess1 = new AxValidationMessage(AxArtifactKey.getNullKey(), AxArtifactKey.class, ValidationResult.OBSERVATION, "Some message"); - result.addValidationMessage(vMess1); - - assertTrue(result.isOK()); + + AxValidationMessage vmess1 = new AxValidationMessage(AxArtifactKey.getNullKey(), AxArtifactKey.class, + ValidationResult.OBSERVATION, "Some message"); + result.addValidationMessage(vmess1); + + assertTrue(result.isOk()); assertTrue(result.isValid()); assertEquals(AxValidationResult.ValidationResult.OBSERVATION, result.getValidationResult()); assertNotNull(result.getMessageList()); assertNotNull("hello", result.toString()); - - AxValidationMessage vMess2 = new AxValidationMessage(AxArtifactKey.getNullKey(), AxArtifactKey.class, ValidationResult.WARNING, "Some message"); - result.addValidationMessage(vMess2); - - assertFalse(result.isOK()); + + AxValidationMessage vmess2 = new AxValidationMessage(AxArtifactKey.getNullKey(), AxArtifactKey.class, + ValidationResult.WARNING, "Some message"); + result.addValidationMessage(vmess2); + + assertFalse(result.isOk()); assertTrue(result.isValid()); assertEquals(AxValidationResult.ValidationResult.WARNING, result.getValidationResult()); assertNotNull(result.getMessageList()); assertNotNull("hello", result.toString()); - - AxValidationMessage vMess3 = new AxValidationMessage(AxArtifactKey.getNullKey(), AxArtifactKey.class, ValidationResult.INVALID, "Some message"); - result.addValidationMessage(vMess3); - - assertFalse(result.isOK()); + + AxValidationMessage vmess3 = new AxValidationMessage(AxArtifactKey.getNullKey(), AxArtifactKey.class, + ValidationResult.INVALID, "Some message"); + result.addValidationMessage(vmess3); + + assertFalse(result.isOk()); assertFalse(result.isValid()); assertEquals(AxValidationResult.ValidationResult.INVALID, result.getValidationResult()); assertNotNull(result.getMessageList()); assertNotNull("hello", result.toString()); - + assertEquals(AxValidationResult.ValidationResult.INVALID, result.getMessageList().get(3).getValidationResult()); assertEquals("Some message", result.getMessageList().get(3).getMessage()); assertEquals(AxArtifactKey.class.getCanonicalName(), result.getMessageList().get(3).getObservedClass()); diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/testKeyUse.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/testKeyUse.java deleted file mode 100644 index 10706f36a..000000000 --- a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/concepts/testKeyUse.java +++ /dev/null @@ -1,82 +0,0 @@ -/* - * ============LICENSE_START======================================================= - * Copyright (C) 2016-2018 Ericsson. All rights reserved. - * ================================================================================ - * 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. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ - -package org.onap.policy.apex.model.basicmodel.concepts; - -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertNotEquals; -import static org.junit.Assert.assertNotNull; -import static org.junit.Assert.assertTrue; - -import org.junit.Test; -import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey; -import org.onap.policy.apex.model.basicmodel.concepts.AxKeyUse; -import org.onap.policy.apex.model.basicmodel.concepts.AxReferenceKey; -import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult; -import org.onap.policy.apex.model.basicmodel.concepts.AxKey.Compatibility; - -public class testKeyUse { - - @Test - public void test() { - assertNotNull(new AxKeyUse()); - assertNotNull(new AxKeyUse(new AxArtifactKey())); - assertNotNull(new AxKeyUse(new AxReferenceKey())); - - AxArtifactKey key = new AxArtifactKey("Key", "0.0.1"); - AxKeyUse keyUse = new AxKeyUse(); - keyUse.setKey(key); - assertEquals(key, keyUse.getKey()); - assertEquals("Key:0.0.1", keyUse.getID()); - assertEquals(key, keyUse.getKeys().get(0)); - - assertEquals(Compatibility.IDENTICAL, keyUse.getCompatibility(key)); - assertTrue(keyUse.isCompatible(key)); - - keyUse.clean(); - assertNotNull(keyUse); - - AxValidationResult result = new AxValidationResult(); - result = keyUse.validate(result); - assertNotNull(result); - - assertNotEquals(0, keyUse.hashCode()); - - AxKeyUse clonedKeyUse = new AxKeyUse(keyUse); - assertEquals("AxKeyUse:(usedKey=AxArtifactKey:(name=Key,version=0.0.1))", clonedKeyUse.toString()); - - assertFalse(keyUse.hashCode() == 0); - - assertTrue(keyUse.equals(keyUse)); - assertTrue(keyUse.equals(clonedKeyUse)); - assertFalse(keyUse.equals("Hello")); - assertTrue(keyUse.equals(new AxKeyUse(key))); - - assertEquals(0, keyUse.compareTo(keyUse)); - assertEquals(0, keyUse.compareTo(clonedKeyUse)); - assertNotEquals(0, keyUse.compareTo(new AxArtifactKey())); - assertEquals(0, keyUse.compareTo(new AxKeyUse(key))); - - AxKeyUse keyUseNull = new AxKeyUse(AxArtifactKey.getNullKey()); - AxValidationResult resultNull = new AxValidationResult(); - assertEquals(false, keyUseNull.validate(resultNull).isValid()); - } -} diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/dao/EntityTest.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/dao/EntityTest.java index e5d597375..4c99ce314 100644 --- a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/dao/EntityTest.java +++ b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/dao/EntityTest.java @@ -45,7 +45,7 @@ import org.onap.policy.apex.model.basicmodel.concepts.AxReferenceKey; import org.onap.policy.apex.model.basicmodel.concepts.TestEntity; /** - * JUnit test class + * JUnit test class. */ public class EntityTest { private Connection connection; @@ -65,7 +65,7 @@ public class EntityTest { @Test public void testEntityTestSanity() throws ApexException { - final DAOParameters daoParameters = new DAOParameters(); + final DaoParameters daoParameters = new DaoParameters(); apexDao = new ApexDaoFactory().createApexDao(daoParameters); @@ -101,10 +101,10 @@ public class EntityTest { } @Test - public void testEntityTestAllOpsJPA() throws ApexException { - final DAOParameters daoParameters = new DAOParameters(); + public void testEntityTestAllOpsJpa() throws ApexException { + final DaoParameters daoParameters = new DaoParameters(); daoParameters.setPluginClass("org.onap.policy.apex.model.basicmodel.dao.impl.DefaultApexDao"); - daoParameters.setPersistenceUnit("DAOTest"); + daoParameters.setPersistenceUnit("DaoTest"); apexDao = new ApexDaoFactory().createApexDao(daoParameters); apexDao.init(daoParameters); @@ -115,9 +115,9 @@ public class EntityTest { @Test public void testEntityTestBadVals() throws ApexException { - final DAOParameters daoParameters = new DAOParameters(); + final DaoParameters daoParameters = new DaoParameters(); daoParameters.setPluginClass("org.onap.policy.apex.model.basicmodel.dao.impl.DefaultApexDao"); - daoParameters.setPersistenceUnit("DAOTest"); + daoParameters.setPersistenceUnit("DaoTest"); apexDao = new ApexDaoFactory().createApexDao(daoParameters); apexDao.init(daoParameters); @@ -130,12 +130,12 @@ public class EntityTest { final List emptyRKeyList = new ArrayList<>(); apexDao.create(nullKey); - apexDao.create(nullKeyList); - apexDao.create(emptyKeyList); + apexDao.createCollection(nullKeyList); + apexDao.createCollection(emptyKeyList); apexDao.delete(nullKey); - apexDao.delete(nullKeyList); - apexDao.delete(emptyKeyList); + apexDao.deleteCollection(nullKeyList); + apexDao.deleteCollection(emptyKeyList); apexDao.delete(AxArtifactKey.class, nullKey); apexDao.delete(AxReferenceKey.class, nullRefKey); apexDao.deleteByArtifactKey(AxArtifactKey.class, nullKeyList); @@ -160,12 +160,12 @@ public class EntityTest { final AxArtifactKey aKey0 = new AxArtifactKey("A-KEY0", "0.0.1"); final AxArtifactKey aKey1 = new AxArtifactKey("A-KEY1", "0.0.1"); final AxArtifactKey aKey2 = new AxArtifactKey("A-KEY2", "0.0.1"); - final AxKeyInfo keyInfo0 = - new AxKeyInfo(aKey0, UUID.fromString("00000000-0000-0000-0000-000000000000"), "key description 0"); - final AxKeyInfo keyInfo1 = - new AxKeyInfo(aKey1, UUID.fromString("00000000-0000-0000-0000-000000000001"), "key description 1"); - final AxKeyInfo keyInfo2 = - new AxKeyInfo(aKey2, UUID.fromString("00000000-0000-0000-0000-000000000002"), "key description 2"); + final AxKeyInfo keyInfo0 = new AxKeyInfo(aKey0, UUID.fromString("00000000-0000-0000-0000-000000000000"), + "key description 0"); + final AxKeyInfo keyInfo1 = new AxKeyInfo(aKey1, UUID.fromString("00000000-0000-0000-0000-000000000001"), + "key description 1"); + final AxKeyInfo keyInfo2 = new AxKeyInfo(aKey2, UUID.fromString("00000000-0000-0000-0000-000000000002"), + "key description 2"); apexDao.create(keyInfo0); @@ -185,7 +185,7 @@ public class EntityTest { keyInfoSetIn.add(keyInfo1); keyInfoSetIn.add(keyInfo2); - apexDao.create(keyInfoSetIn); + apexDao.createCollection(keyInfoSetIn); Set keyInfoSetOut = new TreeSet(apexDao.getAll(AxKeyInfo.class)); @@ -197,14 +197,14 @@ public class EntityTest { keyInfoSetOut = new TreeSet(apexDao.getAll(AxKeyInfo.class)); assertTrue(keyInfoSetIn.equals(keyInfoSetOut)); - apexDao.delete(keyInfoSetIn); + apexDao.deleteCollection(keyInfoSetIn); keyInfoSetOut = new TreeSet(apexDao.getAll(AxKeyInfo.class)); assertEquals(0, keyInfoSetOut.size()); keyInfoSetIn.add(keyInfo0); keyInfoSetIn.add(keyInfo1); keyInfoSetIn.add(keyInfo0); - apexDao.create(keyInfoSetIn); + apexDao.createCollection(keyInfoSetIn); keyInfoSetOut = new TreeSet(apexDao.getAll(AxKeyInfo.class)); assertTrue(keyInfoSetIn.equals(keyInfoSetOut)); @@ -226,7 +226,7 @@ public class EntityTest { keyInfoSetIn.add(keyInfo0); keyInfoSetIn.add(keyInfo1); keyInfoSetIn.add(keyInfo0); - apexDao.create(keyInfoSetIn); + apexDao.createCollection(keyInfoSetIn); keyInfoSetOut = new TreeSet(apexDao.getAll(AxKeyInfo.class)); assertTrue(keyInfoSetIn.equals(keyInfoSetOut)); diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/dao/TestDaoMisc.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/dao/TestDaoMisc.java index 9f5b72d39..7966e8d4f 100644 --- a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/dao/TestDaoMisc.java +++ b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/dao/TestDaoMisc.java @@ -27,28 +27,25 @@ import static org.junit.Assert.fail; import java.util.Properties; import org.junit.Test; -import org.onap.policy.apex.model.basicmodel.dao.converters.CDATAConditioner; -import org.onap.policy.apex.model.basicmodel.dao.converters.UUID2String; +import org.onap.policy.apex.model.basicmodel.dao.converters.CDataConditioner; +import org.onap.policy.apex.model.basicmodel.dao.converters.Uuid2String; -/** - * @author Liam Fallon (liam.fallon@ericsson.com) - */ public class TestDaoMisc { @Test - public void testUUID2StringMopUp() { - final UUID2String uuid2String = new UUID2String(); + public void testUuid2StringMopUp() { + final Uuid2String uuid2String = new Uuid2String(); assertEquals("", uuid2String.convertToDatabaseColumn(null)); } @Test public void testCDataConditionerMopUp() { - assertNull(CDATAConditioner.clean(null)); + assertNull(CDataConditioner.clean(null)); } @Test public void testDaoFactory() { - final DAOParameters daoParameters = new DAOParameters(); + final DaoParameters daoParameters = new DaoParameters(); daoParameters.setPluginClass("somewhere.over.the.rainbow"); try { @@ -63,15 +60,14 @@ public class TestDaoMisc { new ApexDaoFactory().createApexDao(daoParameters); fail("test shold throw an exception here"); } catch (final Exception e) { - assertEquals( - "Specified Apex DAO plugin class \"java.lang.String\" does not implement the ApexDao interface", - e.getMessage()); + assertEquals("Specified Apex DAO plugin class \"java.lang.String\" " + + "does not implement the ApexDao interface", e.getMessage()); } } @Test public void testDaoParameters() { - final DAOParameters pars = new DAOParameters(); + final DaoParameters pars = new DaoParameters(); pars.setJdbcProperties(new Properties()); assertEquals(0, pars.getJdbcProperties().size()); @@ -84,8 +80,7 @@ public class TestDaoMisc { pars.setPluginClass("somewhere.over.the.rainbow"); assertEquals("somewhere.over.the.rainbow", pars.getPluginClass()); - assertEquals( - "DAOParameters [pluginClass=somewhere.over.the.rainbow, persistenceUnit=Kansas, jdbcProperties={name=Dorothy}]", - pars.toString()); + assertEquals("DAOParameters [pluginClass=somewhere.over.the.rainbow, " + + "persistenceUnit=Kansas, jdbcProperties={name=Dorothy}]", pars.toString()); } } diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/AxModelWithReferences.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/AxModelWithReferences.java index 38359052b..8e52b393f 100644 --- a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/AxModelWithReferences.java +++ b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/AxModelWithReferences.java @@ -31,7 +31,7 @@ import org.onap.policy.apex.model.basicmodel.concepts.AxReferenceKey; public class AxModelWithReferences extends AxModel { private static final long serialVersionUID = -8194956638511120008L; - private List extraKeyList = new ArrayList<>(); + private List extrakeyList = new ArrayList<>(); public AxModelWithReferences(final AxArtifactKey key) { super(key); @@ -40,30 +40,33 @@ public class AxModelWithReferences extends AxModel { @Override public List getKeys() { List keys = super.getKeys(); - keys.addAll(extraKeyList); + keys.addAll(extrakeyList); return keys; } - public List getExtraKeyList() { - return extraKeyList; + public List getExtrakeyList() { + return extrakeyList; } + /** + * Set the reference key list. + */ public void setReferenceKeyList() { List keys = super.getKeys(); for (AxKey key: keys) { - AxArtifactKey aKey = (AxArtifactKey)key; - AxReferenceKey keyRef = new AxReferenceKey(aKey, aKey.getName()); - extraKeyList.add(keyRef); + AxArtifactKey akey = (AxArtifactKey)key; + AxReferenceKey keyRef = new AxReferenceKey(akey, akey.getName()); + extrakeyList.add(keyRef); } } - public void addKey(final AxKey aKey) { - extraKeyList.add(aKey); + public void addKey(final AxKey akey) { + extrakeyList.add(akey); } - public void removeKey(final AxKey aKey) { - extraKeyList.remove(aKey); + public void removeKey(final AxKey akey) { + extrakeyList.remove(akey); } } diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestApexBasicModel.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestApexBasicModel.java index d0423eb3a..69942b3df 100644 --- a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestApexBasicModel.java +++ b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestApexBasicModel.java @@ -33,13 +33,18 @@ import org.junit.Test; import org.onap.policy.apex.model.basicmodel.concepts.ApexException; import org.onap.policy.apex.model.basicmodel.concepts.AxModel; import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult; -import org.onap.policy.apex.model.basicmodel.dao.DAOParameters; +import org.onap.policy.apex.model.basicmodel.dao.DaoParameters; import org.onap.policy.apex.model.basicmodel.test.TestApexModel; public class TestApexBasicModel { private Connection connection; TestApexModel testApexModel; + /** + * Set up the test. + * + * @throws Exception any exception thrown by the test + */ @Before public void setup() throws Exception { Class.forName("org.apache.derby.jdbc.EmbeddedDriver").newInstance(); @@ -88,46 +93,57 @@ public class TestApexBasicModel { } @Test - public void testModelWriteReadXML() throws Exception { - testApexModel.testApexModelWriteReadXML(); + public void testModelWriteReadXml() throws Exception { + testApexModel.testApexModelWriteReadXml(); } @Test - public void testModelWriteReadJSON() throws Exception { - testApexModel.testApexModelWriteReadJSON(); + public void testModelWriteReadJson() throws Exception { + testApexModel.testApexModelWriteReadJson(); } @Test - public void testModelWriteReadJPA() throws Exception { - final DAOParameters daoParameters = new DAOParameters(); + public void testModelWriteReadJpa() throws Exception { + final DaoParameters daoParameters = new DaoParameters(); daoParameters.setPluginClass("org.onap.policy.apex.model.basicmodel.dao.impl.DefaultApexDao"); - daoParameters.setPersistenceUnit("DAOTest"); + daoParameters.setPersistenceUnit("DaoTest"); - testApexModel.testApexModelWriteReadJPA(daoParameters); + testApexModel.testApexModelWriteReadJpa(daoParameters); } // As there are no real concepts in a basic model, this is as near to a valid model as we can get private static final String VALID_MODEL_STRING = "\n" + "***warnings issued during validation of model***\n" - + "AxArtifactKey:(name=FloatKIKey,version=0.0.1):org.onap.policy.apex.model.basicmodel.concepts.AxModel:WARNING:key not found for key information entry\n" - + "AxArtifactKey:(name=IntegerKIKey,version=0.0.1):org.onap.policy.apex.model.basicmodel.concepts.AxModel:WARNING:key not found for key information entry\n" - + "********************************"; + + "AxArtifactKey:(name=FloatKIKey,version=0.0.1):org.onap.policy.apex.model.basicmodel.concepts" + + ".AxModel:WARNING:key not found for key information entry\n" + + "AxArtifactKey:(name=IntegerKIKey,version=0.0.1):org.onap.policy.apex.model.basicmodel.concepts" + + ".AxModel:WARNING:key not found for key information entry\n" + "********************************"; private static final String WARNING_MODEL_STRING = "\n" + "***warnings issued during validation of model***\n" - + "AxArtifactKey:(name=FloatKIKey,version=0.0.1):org.onap.policy.apex.model.basicmodel.concepts.AxModel:WARNING:key not found for key information entry\n" - + "AxArtifactKey:(name=IntegerKIKey,version=0.0.1):org.onap.policy.apex.model.basicmodel.concepts.AxModel:WARNING:key not found for key information entry\n" - + "AxArtifactKey:(name=Unref0,version=0.0.1):org.onap.policy.apex.model.basicmodel.concepts.AxModel:WARNING:key not found for key information entry\n" - + "AxArtifactKey:(name=Unref1,version=0.0.1):org.onap.policy.apex.model.basicmodel.concepts.AxModel:WARNING:key not found for key information entry\n" - + "********************************"; + + "AxArtifactKey:(name=FloatKIKey,version=0.0.1):org.onap.policy.apex.model.basicmodel.concepts" + + ".AxModel:WARNING:key not found for key information entry\n" + + "AxArtifactKey:(name=IntegerKIKey,version=0.0.1):org.onap.policy.apex.model.basicmodel.concepts" + + ".AxModel:WARNING:key not found for key information entry\n" + + "AxArtifactKey:(name=Unref0,version=0.0.1):org.onap.policy.apex.model.basicmodel.concepts" + + ".AxModel:WARNING:key not found for key information entry\n" + + "AxArtifactKey:(name=Unref1,version=0.0.1):org.onap.policy.apex.model.basicmodel.concepts" + + ".AxModel:WARNING:key not found for key information entry\n" + "********************************"; private static final String INVALID_MODEL_STRING = "\n" + "***validation of model failed***\n" - + "AxArtifactKey:(name=BasicModelKey,version=0.0.1):org.onap.policy.apex.model.basicmodel.concepts.AxKeyInfo:WARNING:UUID is a zero UUID: 00000000-0000-0000-0000-000000000000\n" - + "AxArtifactKey:(name=KeyInfoMapKey,version=0.0.1):org.onap.policy.apex.model.basicmodel.concepts.AxKeyInfo:OBSERVATION:description is blank\n" - + "AxArtifactKey:(name=KeyInfoMapKey,version=0.0.1):org.onap.policy.apex.model.basicmodel.concepts.AxKeyInfo:WARNING:UUID is a zero UUID: 00000000-0000-0000-0000-000000000000\n" - + "AxArtifactKey:(name=KeyInfoMapKey,version=0.0.1):org.onap.policy.apex.model.basicmodel.concepts.AxKeyInformation:INVALID:duplicate UUID found on keyInfoMap entry AxArtifactKey:(name=KeyInfoMapKey,version=0.0.1):00000000-0000-0000-0000-000000000000\n" - + "********************************"; + + "AxArtifactKey:(name=BasicModelKey,version=0.0.1):org.onap.policy.apex.model.basicmodel.concepts." + + "AxKeyInfo:WARNING:UUID is a zero UUID: 00000000-0000-0000-0000-000000000000\n" + + "AxArtifactKey:(name=KeyInfoMapKey,version=0.0.1):org.onap.policy.apex.model.basicmodel.concepts." + + "AxKeyInfo:OBSERVATION:description is blank\n" + + "AxArtifactKey:(name=KeyInfoMapKey,version=0.0.1):org.onap.policy.apex.model.basicmodel.concepts." + + "AxKeyInfo:WARNING:UUID is a zero UUID: 00000000-0000-0000-0000-000000000000\n" + + "AxArtifactKey:(name=KeyInfoMapKey,version=0.0.1):org.onap.policy.apex.model.basicmodel.concepts." + + "AxKeyInformation:INVALID:duplicate UUID found on keyInfoMap entry AxArtifactKey:" + + "(name=KeyInfoMapKey,version=0.0.1):00000000-0000-0000-0000-000000000000\n" + + "********************************"; private static final String INVALID_MODEL_MALSTRUCTURED_STRING = "\n" + "***validation of model failed***\n" - + "AxArtifactKey:(name=BasicModelKey,version=0.0.1):org.onap.policy.apex.model.basicmodel.concepts.AxKeyInfo:WARNING:UUID is a zero UUID: 00000000-0000-0000-0000-000000000000\n" - + "AxArtifactKey:(name=BasicModelKey,version=0.0.1):org.onap.policy.apex.model.basicmodel.concepts.AxModel:INVALID:key information not found for key AxArtifactKey:(name=KeyInfoMapKey,version=0.0.1)\n" - + "********************************"; + + "AxArtifactKey:(name=BasicModelKey,version=0.0.1):org.onap.policy.apex.model.basicmodel.concepts." + + "AxKeyInfo:WARNING:UUID is a zero UUID: 00000000-0000-0000-0000-000000000000\n" + + "AxArtifactKey:(name=BasicModelKey,version=0.0.1):org.onap.policy.apex.model.basicmodel.concepts." + + "AxModel:INVALID:key information not found for key " + + "AxArtifactKey:(name=KeyInfoMapKey,version=0.0.1)\n" + "********************************"; } diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestApexBasicModelConcepts.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestApexBasicModelConcepts.java index 1ab7a2666..11cab6d88 100644 --- a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestApexBasicModelConcepts.java +++ b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestApexBasicModelConcepts.java @@ -257,20 +257,20 @@ public class TestApexBasicModelConcepts { mwr.removeKey(keyU); // Key Use on bad artifact key - final AxKeyUse keyBU = new AxKeyUse(new AxArtifactKey("SomeKey", "0.0.1")); - mwr.addKey(keyBU); + final AxKeyUse keyBadUsage = new AxKeyUse(new AxArtifactKey("SomeKey", "0.0.1")); + mwr.addKey(keyBadUsage); result = new AxValidationResult(); result = mwr.validate(result); assertEquals(ValidationResult.INVALID, result.getValidationResult()); - mwr.removeKey(keyBU); + mwr.removeKey(keyBadUsage); // Key Use on bad reference key - final AxKeyUse keyBRU = new AxKeyUse(new AxReferenceKey("SomeKey", "0.0.1", "Local")); - mwr.addKey(keyBRU); + final AxKeyUse keyBadReferenceUsage = new AxKeyUse(new AxReferenceKey("SomeKey", "0.0.1", "Local")); + mwr.addKey(keyBadReferenceUsage); result = new AxValidationResult(); result = mwr.validate(result); assertEquals(ValidationResult.INVALID, result.getValidationResult()); - mwr.removeKey(keyBRU); + mwr.removeKey(keyBadReferenceUsage); result = new AxValidationResult(); result = mwr.validate(result); diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestApexBasicModelCreator.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestApexBasicModelCreator.java index 762c7555f..b11669fdf 100644 --- a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestApexBasicModelCreator.java +++ b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestApexBasicModelCreator.java @@ -38,13 +38,16 @@ public class TestApexBasicModelCreator implements TestApexModelCreator basicModel.setKeyInformation(new AxKeyInformation(new AxArtifactKey("KeyInfoMapKey", "0.0.1"))); basicModel.getKeyInformation().getKeyInfoMap().put(basicModel.getKey(), new AxKeyInfo(basicModel.getKey())); - basicModel.getKeyInformation().getKeyInfoMap().put(basicModel.getKeyInformation().getKey(), new AxKeyInfo(basicModel.getKeyInformation().getKey())); + basicModel.getKeyInformation().getKeyInfoMap().put(basicModel.getKeyInformation().getKey(), + new AxKeyInfo(basicModel.getKeyInformation().getKey())); - AxKeyInfo intKI = new AxKeyInfo(new AxArtifactKey("IntegerKIKey", "0.0.1"), UUID.randomUUID(), "IntegerKIKey description"); - basicModel.getKeyInformation().getKeyInfoMap().put(intKI.getKey(), new AxKeyInfo(intKI.getKey())); + AxKeyInfo intKeyInfo = new AxKeyInfo(new AxArtifactKey("IntegerKIKey", "0.0.1"), UUID.randomUUID(), + "IntegerKIKey description"); + basicModel.getKeyInformation().getKeyInfoMap().put(intKeyInfo.getKey(), new AxKeyInfo(intKeyInfo.getKey())); - AxKeyInfo floatKI = new AxKeyInfo(new AxArtifactKey("FloatKIKey", "0.0.1"), UUID.randomUUID(), "FloatKIKey description"); - basicModel.getKeyInformation().getKeyInfoMap().put(floatKI.getKey(), new AxKeyInfo(floatKI.getKey())); + AxKeyInfo floatKeyInfo = new AxKeyInfo(new AxArtifactKey("FloatKIKey", "0.0.1"), UUID.randomUUID(), + "FloatKIKey description"); + basicModel.getKeyInformation().getKeyInfoMap().put(floatKeyInfo.getKey(), new AxKeyInfo(floatKeyInfo.getKey())); return basicModel; } @@ -57,10 +60,7 @@ public class TestApexBasicModelCreator implements TestApexModelCreator basicModel.setKey(new AxArtifactKey("BasicModelKey", "0.0.1")); basicModel.setKeyInformation(new AxKeyInformation(new AxArtifactKey("KeyInfoMapKey", "0.0.1"))); - basicModel.getKeyInformation().getKeyInfoMap().put( - basicModel.getKey(), - new AxKeyInfo( - basicModel.getKey(), + basicModel.getKeyInformation().getKeyInfoMap().put(basicModel.getKey(), new AxKeyInfo(basicModel.getKey(), UUID.fromString("00000000-0000-0000-0000-000000000000"), "\nbasic model description\nThis is a multi line description\nwith another line of text.")); @@ -98,29 +98,27 @@ public class TestApexBasicModelCreator implements TestApexModelCreator basicModel.setKey(new AxArtifactKey("BasicModelKey", "0.0.1")); basicModel.setKeyInformation(new AxKeyInformation(new AxArtifactKey("KeyInfoMapKey", "0.0.1"))); - basicModel.getKeyInformation().getKeyInfoMap().put( - basicModel.getKey(), - new AxKeyInfo( - basicModel.getKey(), + basicModel.getKeyInformation().getKeyInfoMap().put(basicModel.getKey(), new AxKeyInfo(basicModel.getKey(), UUID.fromString("00000000-0000-0000-0000-000000000000"), "nbasic model description\nThis is a multi line description\nwith another line of text.")); - basicModel.getKeyInformation().getKeyInfoMap().put( - basicModel.getKeyInformation().getKey(), - new AxKeyInfo( - basicModel.getKeyInformation().getKey(), - UUID.fromString("00000000-0000-0000-0000-000000000000"), - "")); + basicModel.getKeyInformation().getKeyInfoMap().put(basicModel.getKeyInformation().getKey(), + new AxKeyInfo(basicModel.getKeyInformation().getKey(), + UUID.fromString("00000000-0000-0000-0000-000000000000"), "")); return basicModel; } - + + /** + * Get the model with its references. + * @return the model with its references + */ public final AxModelWithReferences getModelWithReferences() { AxModel model = getModel(); - + AxModelWithReferences modelWithReferences = new AxModelWithReferences(model.getKey()); modelWithReferences.setKeyInformation(model.getKeyInformation()); modelWithReferences.setReferenceKeyList(); - + return modelWithReferences; } } diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestApexTestModelCreator0.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestApexTestModelCreator0.java index ff958373e..a3d841a51 100644 --- a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestApexTestModelCreator0.java +++ b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestApexTestModelCreator0.java @@ -36,7 +36,8 @@ public class TestApexTestModelCreator0 implements TestApexModelCreator basicModel.setKeyInformation(new AxKeyInformation(new AxArtifactKey("KeyInfoMapKey", "0.0.1"))); basicModel.getKeyInformation().getKeyInfoMap().put(basicModel.getKey(), new AxKeyInfo(basicModel.getKey())); - basicModel.getKeyInformation().getKeyInfoMap().put(basicModel.getKeyInformation().getKey(), new AxKeyInfo(basicModel.getKeyInformation().getKey())); + basicModel.getKeyInformation().getKeyInfoMap().put(basicModel.getKeyInformation().getKey(), + new AxKeyInfo(basicModel.getKeyInformation().getKey())); return basicModel; } diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestApexTestModelCreator1.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestApexTestModelCreator1.java index d2aa738a0..cbbe05a36 100644 --- a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestApexTestModelCreator1.java +++ b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestApexTestModelCreator1.java @@ -57,18 +57,12 @@ public class TestApexTestModelCreator1 implements TestApexModelCreator basicModel.setKey(new AxArtifactKey("BasicModelKey", "0.0.1")); basicModel.setKeyInformation(new AxKeyInformation(new AxArtifactKey("KeyInfoMapKey", "0.0.1"))); - basicModel.getKeyInformation().getKeyInfoMap().put( - basicModel.getKey(), - new AxKeyInfo( - basicModel.getKey(), + basicModel.getKeyInformation().getKeyInfoMap().put(basicModel.getKey(), new AxKeyInfo(basicModel.getKey(), UUID.fromString("00000000-0000-0000-0000-000000000000"), "nbasic model description\nThis is a multi line description\nwith another line of text.")); - basicModel.getKeyInformation().getKeyInfoMap().put( - basicModel.getKeyInformation().getKey(), - new AxKeyInfo( - basicModel.getKeyInformation().getKey(), - UUID.fromString("00000000-0000-0000-0000-000000000000"), - "")); + basicModel.getKeyInformation().getKeyInfoMap().put(basicModel.getKeyInformation().getKey(), + new AxKeyInfo(basicModel.getKeyInformation().getKey(), + UUID.fromString("00000000-0000-0000-0000-000000000000"), "")); return basicModel; } diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestApexTestModelCreator2.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestApexTestModelCreator2.java index 85751bf12..a7b77865d 100644 --- a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestApexTestModelCreator2.java +++ b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestApexTestModelCreator2.java @@ -36,7 +36,8 @@ public class TestApexTestModelCreator2 implements TestApexModelCreator basicModel.setKeyInformation(new AxKeyInformation(new AxArtifactKey("KeyInfoMapKey", "0.0.1"))); basicModel.getKeyInformation().getKeyInfoMap().put(basicModel.getKey(), new AxKeyInfo(basicModel.getKey())); - basicModel.getKeyInformation().getKeyInfoMap().put(basicModel.getKeyInformation().getKey(), new AxKeyInfo(basicModel.getKeyInformation().getKey())); + basicModel.getKeyInformation().getKeyInfoMap().put(basicModel.getKeyInformation().getKey(), + new AxKeyInfo(basicModel.getKeyInformation().getKey())); basicModel.getKeyInformation().get("BasicModel").setDescription(""); return basicModel; } diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestBasicModelTest.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestBasicModelTest.java index 9ddd3cc7e..9ced9d84b 100644 --- a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestBasicModelTest.java +++ b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestBasicModelTest.java @@ -29,15 +29,12 @@ import org.onap.policy.apex.model.basicmodel.concepts.ApexException; import org.onap.policy.apex.model.basicmodel.concepts.AxModel; import org.onap.policy.apex.model.basicmodel.test.TestApexModel; -/** - * @author Liam Fallon (liam.fallon@ericsson.com) - */ public class TestBasicModelTest { @Test public void testNormalModelCreator() throws ApexException { - final TestApexModel testApexModel = - new TestApexModel(AxModel.class, new TestApexBasicModelCreator()); + final TestApexModel testApexModel = new TestApexModel(AxModel.class, + new TestApexBasicModelCreator()); testApexModel.testApexModelValid(); try { @@ -50,14 +47,14 @@ public class TestBasicModelTest { testApexModel.testApexModelVaidateInvalidModel(); testApexModel.testApexModelVaidateMalstructured(); - testApexModel.testApexModelWriteReadJSON(); - testApexModel.testApexModelWriteReadXML(); + testApexModel.testApexModelWriteReadJson(); + testApexModel.testApexModelWriteReadXml(); } @Test public void testModelCreator0() throws ApexException { - final TestApexModel testApexModel = - new TestApexModel(AxModel.class, new TestApexTestModelCreator0()); + final TestApexModel testApexModel = new TestApexModel(AxModel.class, + new TestApexTestModelCreator0()); testApexModel.testApexModelValid(); try { @@ -88,8 +85,8 @@ public class TestBasicModelTest { @Test public void testModelCreator1() throws ApexException { - final TestApexModel testApexModel = - new TestApexModel(AxModel.class, new TestApexTestModelCreator1()); + final TestApexModel testApexModel = new TestApexModel(AxModel.class, + new TestApexTestModelCreator1()); try { testApexModel.testApexModelValid(); @@ -115,8 +112,8 @@ public class TestBasicModelTest { @Test public void testModelCreator2() throws ApexException { - final TestApexModel testApexModel = - new TestApexModel(AxModel.class, new TestApexTestModelCreator2()); + final TestApexModel testApexModel = new TestApexModel(AxModel.class, + new TestApexTestModelCreator2()); testApexModel.testApexModelValid(); testApexModel.testApexModelVaidateObservation(); @@ -129,19 +126,19 @@ public class TestBasicModelTest { } @Test - public void testModelCreator1XMLJSON() throws ApexException { - final TestApexModel testApexModel = - new TestApexModel(AxModel.class, new TestApexTestModelCreator1()); + public void testModelCreator1XmlJson() throws ApexException { + final TestApexModel testApexModel = new TestApexModel(AxModel.class, + new TestApexTestModelCreator1()); try { - testApexModel.testApexModelWriteReadJSON(); + testApexModel.testApexModelWriteReadJson(); fail("Test should throw an exception"); } catch (final Exception e) { assertTrue(e.getMessage().startsWith("error processing file")); } try { - testApexModel.testApexModelWriteReadXML(); + testApexModel.testApexModelWriteReadXml(); fail("Test should throw an exception"); } catch (final Exception e) { assertTrue(e.getMessage().startsWith("error processing file")); diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestConceptGetter.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestConceptGetter.java index 83545bf06..f95c0b41d 100644 --- a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestConceptGetter.java +++ b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestConceptGetter.java @@ -37,37 +37,55 @@ import org.onap.policy.apex.model.basicmodel.concepts.AxModel; import org.onap.policy.apex.model.basicmodel.handling.ApexModelFileWriter; import org.onap.policy.apex.model.basicmodel.handling.ApexModelReader; -/** - * @author Liam Fallon (liam.fallon@ericsson.com) - */ public class TestConceptGetter { @Test public void testConceptGetter() throws IOException, ApexException { AxModel basicModel = new TestApexBasicModelCreator().getModel(); assertNotNull(basicModel); - - AxKeyInfo intKI01 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey01", "0.0.1"), UUID.randomUUID(), "IntegerKIKey01 description"); - AxKeyInfo intKI11 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey11", "0.0.1"), UUID.randomUUID(), "IntegerKIKey11 description"); - AxKeyInfo intKI21 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey21", "0.0.1"), UUID.randomUUID(), "IntegerKIKey21 description"); - AxKeyInfo intKI22 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey22", "0.0.2"), UUID.randomUUID(), "IntegerKIKey22 description"); - AxKeyInfo intKI23 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey23", "0.0.3"), UUID.randomUUID(), "IntegerKIKey23 description"); - AxKeyInfo intKI24 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey24", "0.0.4"), UUID.randomUUID(), "IntegerKIKey24 description"); - AxKeyInfo intKI25 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey25", "0.0.5"), UUID.randomUUID(), "IntegerKIKey25 description"); - AxKeyInfo intKI26 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey26", "0.0.6"), UUID.randomUUID(), "IntegerKIKey26 description"); - AxKeyInfo intKI31 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey31", "0.0.1"), UUID.randomUUID(), "IntegerKIKey31 description"); - AxKeyInfo intKI41 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey41", "0.0.1"), UUID.randomUUID(), "IntegerKIKey41 description"); - AxKeyInfo intKI51 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey51", "0.0.1"), UUID.randomUUID(), "IntegerKIKey51 description"); - AxKeyInfo intKI52 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey52", "0.0.2"), UUID.randomUUID(), "IntegerKIKey52 description"); - AxKeyInfo intKI53 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey53", "0.0.3"), UUID.randomUUID(), "IntegerKIKey53 description"); - AxKeyInfo intKI54 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey54", "0.0.4"), UUID.randomUUID(), "IntegerKIKey54 description"); - AxKeyInfo intKI61 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey61", "0.0.1"), UUID.randomUUID(), "IntegerKIKey61 description"); - AxKeyInfo intKI62 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey62", "0.0.2"), UUID.randomUUID(), "IntegerKIKey62 description"); - AxKeyInfo intKI63 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey63", "0.0.3"), UUID.randomUUID(), "IntegerKIKey63 description"); - AxKeyInfo intKI64 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey64", "0.0.4"), UUID.randomUUID(), "IntegerKIKey64 description"); - AxKeyInfo intKI71 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey71", "0.0.1"), UUID.randomUUID(), "IntegerKIKey71 description"); - AxKeyInfo intKI81 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey81", "0.0.1"), UUID.randomUUID(), "IntegerKIKey81 description"); - AxKeyInfo intKI91 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey91", "0.0.1"), UUID.randomUUID(), "IntegerKIKey91 description"); + + AxKeyInfo intKI01 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey01", "0.0.1"), UUID.randomUUID(), + "IntegerKIKey01 description"); + AxKeyInfo intKI11 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey11", "0.0.1"), UUID.randomUUID(), + "IntegerKIKey11 description"); + AxKeyInfo intKI21 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey21", "0.0.1"), UUID.randomUUID(), + "IntegerKIKey21 description"); + AxKeyInfo intKI22 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey22", "0.0.2"), UUID.randomUUID(), + "IntegerKIKey22 description"); + AxKeyInfo intKI23 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey23", "0.0.3"), UUID.randomUUID(), + "IntegerKIKey23 description"); + AxKeyInfo intKI24 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey24", "0.0.4"), UUID.randomUUID(), + "IntegerKIKey24 description"); + AxKeyInfo intKI25 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey25", "0.0.5"), UUID.randomUUID(), + "IntegerKIKey25 description"); + AxKeyInfo intKI26 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey26", "0.0.6"), UUID.randomUUID(), + "IntegerKIKey26 description"); + AxKeyInfo intKI31 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey31", "0.0.1"), UUID.randomUUID(), + "IntegerKIKey31 description"); + AxKeyInfo intKI41 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey41", "0.0.1"), UUID.randomUUID(), + "IntegerKIKey41 description"); + AxKeyInfo intKI51 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey51", "0.0.1"), UUID.randomUUID(), + "IntegerKIKey51 description"); + AxKeyInfo intKI52 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey52", "0.0.2"), UUID.randomUUID(), + "IntegerKIKey52 description"); + AxKeyInfo intKI53 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey53", "0.0.3"), UUID.randomUUID(), + "IntegerKIKey53 description"); + AxKeyInfo intKI54 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey54", "0.0.4"), UUID.randomUUID(), + "IntegerKIKey54 description"); + AxKeyInfo intKI61 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey61", "0.0.1"), UUID.randomUUID(), + "IntegerKIKey61 description"); + AxKeyInfo intKI62 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey62", "0.0.2"), UUID.randomUUID(), + "IntegerKIKey62 description"); + AxKeyInfo intKI63 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey63", "0.0.3"), UUID.randomUUID(), + "IntegerKIKey63 description"); + AxKeyInfo intKI64 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey64", "0.0.4"), UUID.randomUUID(), + "IntegerKIKey64 description"); + AxKeyInfo intKI71 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey71", "0.0.1"), UUID.randomUUID(), + "IntegerKIKey71 description"); + AxKeyInfo intKI81 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey81", "0.0.1"), UUID.randomUUID(), + "IntegerKIKey81 description"); + AxKeyInfo intKI91 = new AxKeyInfo(new AxArtifactKey("IntegerKIKey91", "0.0.1"), UUID.randomUUID(), + "IntegerKIKey91 description"); basicModel.getKeyInformation().getKeyInfoMap().put(intKI31.getKey(), intKI31); basicModel.getKeyInformation().getKeyInfoMap().put(intKI24.getKey(), intKI24); basicModel.getKeyInformation().getKeyInfoMap().put(intKI11.getKey(), intKI11); @@ -90,20 +108,34 @@ public class TestConceptGetter { basicModel.getKeyInformation().getKeyInfoMap().put(intKI61.getKey(), intKI61); basicModel.getKeyInformation().getKeyInfoMap().put(intKI63.getKey(), intKI63); - AxKeyInfo floatKI01 = new AxKeyInfo(new AxArtifactKey("FloatKIKey01", "0.0.1"), UUID.randomUUID(), "IntegerKIKey01 description"); - AxKeyInfo floatKI11 = new AxKeyInfo(new AxArtifactKey("FloatKIKey11", "0.0.1"), UUID.randomUUID(), "IntegerKIKey11 description"); - AxKeyInfo floatKI21 = new AxKeyInfo(new AxArtifactKey("FloatKIKey21", "0.0.1"), UUID.randomUUID(), "IntegerKIKey21 description"); - AxKeyInfo floatKI31 = new AxKeyInfo(new AxArtifactKey("FloatKIKey31", "0.0.1"), UUID.randomUUID(), "IntegerKIKey31 description"); - AxKeyInfo floatKI41 = new AxKeyInfo(new AxArtifactKey("FloatKIKey41", "0.0.1"), UUID.randomUUID(), "IntegerKIKey41 description"); - AxKeyInfo floatKI51 = new AxKeyInfo(new AxArtifactKey("FloatKIKey51", "0.0.1"), UUID.randomUUID(), "IntegerKIKey51 description"); - AxKeyInfo floatKI61 = new AxKeyInfo(new AxArtifactKey("FloatKIKey61", "0.0.1"), UUID.randomUUID(), "IntegerKIKey61 description"); - AxKeyInfo floatKI71 = new AxKeyInfo(new AxArtifactKey("FloatKIKey71", "0.0.1"), UUID.randomUUID(), "IntegerKIKey71 description"); - AxKeyInfo floatKI81 = new AxKeyInfo(new AxArtifactKey("FloatKIKey81", "0.0.1"), UUID.randomUUID(), "IntegerKIKey81 description"); - AxKeyInfo floatKI82 = new AxKeyInfo(new AxArtifactKey("FloatKIKey82", "0.0.2"), UUID.randomUUID(), "IntegerKIKey82 description"); - AxKeyInfo floatKI83 = new AxKeyInfo(new AxArtifactKey("FloatKIKey83", "0.0.3"), UUID.randomUUID(), "IntegerKIKey83 description"); - AxKeyInfo floatKI91 = new AxKeyInfo(new AxArtifactKey("FloatKIKey91", "0.0.1"), UUID.randomUUID(), "IntegerKIKey91 description"); - AxKeyInfo floatKI92 = new AxKeyInfo(new AxArtifactKey("FloatKIKey92", "0.0.2"), UUID.randomUUID(), "IntegerKIKey92 description"); - AxKeyInfo floatKI93 = new AxKeyInfo(new AxArtifactKey("FloatKIKey93", "0.0.3"), UUID.randomUUID(), "IntegerKIKey93 description"); + AxKeyInfo floatKI01 = new AxKeyInfo(new AxArtifactKey("FloatKIKey01", "0.0.1"), UUID.randomUUID(), + "IntegerKIKey01 description"); + AxKeyInfo floatKI11 = new AxKeyInfo(new AxArtifactKey("FloatKIKey11", "0.0.1"), UUID.randomUUID(), + "IntegerKIKey11 description"); + AxKeyInfo floatKI21 = new AxKeyInfo(new AxArtifactKey("FloatKIKey21", "0.0.1"), UUID.randomUUID(), + "IntegerKIKey21 description"); + AxKeyInfo floatKI31 = new AxKeyInfo(new AxArtifactKey("FloatKIKey31", "0.0.1"), UUID.randomUUID(), + "IntegerKIKey31 description"); + AxKeyInfo floatKI41 = new AxKeyInfo(new AxArtifactKey("FloatKIKey41", "0.0.1"), UUID.randomUUID(), + "IntegerKIKey41 description"); + AxKeyInfo floatKI51 = new AxKeyInfo(new AxArtifactKey("FloatKIKey51", "0.0.1"), UUID.randomUUID(), + "IntegerKIKey51 description"); + AxKeyInfo floatKI61 = new AxKeyInfo(new AxArtifactKey("FloatKIKey61", "0.0.1"), UUID.randomUUID(), + "IntegerKIKey61 description"); + AxKeyInfo floatKI71 = new AxKeyInfo(new AxArtifactKey("FloatKIKey71", "0.0.1"), UUID.randomUUID(), + "IntegerKIKey71 description"); + AxKeyInfo floatKI81 = new AxKeyInfo(new AxArtifactKey("FloatKIKey81", "0.0.1"), UUID.randomUUID(), + "IntegerKIKey81 description"); + AxKeyInfo floatKI82 = new AxKeyInfo(new AxArtifactKey("FloatKIKey82", "0.0.2"), UUID.randomUUID(), + "IntegerKIKey82 description"); + AxKeyInfo floatKI83 = new AxKeyInfo(new AxArtifactKey("FloatKIKey83", "0.0.3"), UUID.randomUUID(), + "IntegerKIKey83 description"); + AxKeyInfo floatKI91 = new AxKeyInfo(new AxArtifactKey("FloatKIKey91", "0.0.1"), UUID.randomUUID(), + "IntegerKIKey91 description"); + AxKeyInfo floatKI92 = new AxKeyInfo(new AxArtifactKey("FloatKIKey92", "0.0.2"), UUID.randomUUID(), + "IntegerKIKey92 description"); + AxKeyInfo floatKI93 = new AxKeyInfo(new AxArtifactKey("FloatKIKey93", "0.0.3"), UUID.randomUUID(), + "IntegerKIKey93 description"); basicModel.getKeyInformation().getKeyInfoMap().put(floatKI11.getKey(), floatKI11); basicModel.getKeyInformation().getKeyInfoMap().put(floatKI83.getKey(), floatKI83); basicModel.getKeyInformation().getKeyInfoMap().put(floatKI51.getKey(), floatKI51); @@ -124,9 +156,9 @@ public class TestConceptGetter { assertTrue(basicModel.getKeyInformation().get("IntegerKIKey62", "0.0.2").equals(intKI62)); assertTrue(basicModel.getKeyInformation().get("IntegerKIKey21", "0.0.1").equals(intKI21)); assertTrue(basicModel.getKeyInformation().get("IntegerKIKey61", "0.0.1").equals(intKI61)); - + assertNull(basicModel.getKeyInformation().get("NonExistantKey")); - + assertTrue(basicModel.getKeyInformation().get("IntegerKIKey01").equals(intKI01)); assertTrue(basicModel.getKeyInformation().get("IntegerKIKey11").equals(intKI11)); assertTrue(basicModel.getKeyInformation().get("IntegerKIKey26").equals(intKI26)); @@ -137,7 +169,7 @@ public class TestConceptGetter { assertTrue(basicModel.getKeyInformation().get("IntegerKIKey71").equals(intKI71)); assertTrue(basicModel.getKeyInformation().get("IntegerKIKey81").equals(intKI81)); assertTrue(basicModel.getKeyInformation().get("IntegerKIKey91").equals(intKI91)); - + assertTrue(basicModel.getKeyInformation().get("FloatKIKey01").equals(floatKI01)); assertTrue(basicModel.getKeyInformation().get("FloatKIKey11").equals(floatKI11)); assertTrue(basicModel.getKeyInformation().get("FloatKIKey21").equals(floatKI21)); @@ -149,23 +181,22 @@ public class TestConceptGetter { assertTrue(basicModel.getKeyInformation().get("FloatKIKey83").equals(floatKI83)); assertTrue(basicModel.getKeyInformation().get("FloatKIKey93").equals(floatKI93)); - // Ensure marshalling and unmarshalling is OK ApexModelReader modelReader = new ApexModelReader(AxModel.class); ApexModelFileWriter modelWriter = new ApexModelFileWriter(true); - + modelReader.setValidateFlag(false); modelWriter.setValidateFlag(false); - - File tempXMLFile = File.createTempFile("ApexModel", "xml"); - modelWriter.apexModelWriteJSONFile(basicModel, AxModel.class, tempXMLFile.getCanonicalPath()); - - FileInputStream xmlFileInputStream = new FileInputStream(tempXMLFile); - AxModel readXMLModel = modelReader.read(xmlFileInputStream); + + File tempXmlFile = File.createTempFile("ApexModel", "xml"); + modelWriter.apexModelWriteJsonFile(basicModel, AxModel.class, tempXmlFile.getCanonicalPath()); + + FileInputStream xmlFileInputStream = new FileInputStream(tempXmlFile); + AxModel readXmlModel = modelReader.read(xmlFileInputStream); xmlFileInputStream.close(); - assertTrue(basicModel.equals(readXMLModel)); - assertTrue(readXMLModel.getKeyInformation().get("IntegerKIKey91").equals(intKI91)); - assertNotNull(readXMLModel.getKeyInformation().get("FloatKIKey")); - tempXMLFile.delete(); + assertTrue(basicModel.equals(readXmlModel)); + assertTrue(readXmlModel.getKeyInformation().get("IntegerKIKey91").equals(intKI91)); + assertNotNull(readXmlModel.getKeyInformation().get("FloatKIKey")); + tempXmlFile.delete(); } } diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestExceptions.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestExceptions.java index 5c8922793..8b0196b31 100644 --- a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestExceptions.java +++ b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestExceptions.java @@ -28,9 +28,6 @@ import java.io.IOException; import org.junit.Test; import org.onap.policy.apex.model.basicmodel.handling.ApexModelException; -/** - * @author Liam Fallon (liam.fallon@ericsson.com) - */ public class TestExceptions { @Test diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestModelFileWriter.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestModelFileWriter.java index ec4d0a5a9..3e860e3b1 100644 --- a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestModelFileWriter.java +++ b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestModelFileWriter.java @@ -31,15 +31,10 @@ import org.onap.policy.apex.model.basicmodel.concepts.ApexException; import org.onap.policy.apex.model.basicmodel.concepts.AxModel; import org.onap.policy.apex.model.basicmodel.handling.ApexModelFileWriter; -/** - * @author Liam Fallon (liam.fallon@ericsson.com) - */ public class TestModelFileWriter { @Test public void testModelFileWriter() throws IOException, ApexException { - AxModel model = new TestApexBasicModelCreator().getModel(); - ApexModelFileWriter modelFileWriter = new ApexModelFileWriter<>(true); modelFileWriter.setValidateFlag(true); @@ -52,9 +47,10 @@ public class TestModelFileWriter { File jsonTempFile = new File(tempDir.getAbsolutePath() + "/aaa/ApexFileWriterTest.json"); File xmlTempFile = new File(tempDir.getAbsolutePath() + "/ccc/ApexFileWriterTest.xml"); - modelFileWriter.apexModelWriteJSONFile(model, AxModel.class, jsonTempFile.getAbsolutePath()); + AxModel model = new TestApexBasicModelCreator().getModel(); - modelFileWriter.apexModelWriteXMLFile(model, AxModel.class, xmlTempFile.getAbsolutePath()); + modelFileWriter.apexModelWriteJsonFile(model, AxModel.class, jsonTempFile.getAbsolutePath()); + modelFileWriter.apexModelWriteXmlFile(model, AxModel.class, xmlTempFile.getAbsolutePath()); jsonTempFile.delete(); xmlTempFile.delete(); @@ -64,8 +60,8 @@ public class TestModelFileWriter { jsonTempFile = new File(tempDir.getAbsolutePath() + "/aaa/bbb/ApexFileWriterTest.json"); xmlTempFile = new File(tempDir.getAbsolutePath() + "/ccc/ddd/ApexFileWriterTest.xml"); - modelFileWriter.apexModelWriteJSONFile(model, AxModel.class, jsonTempFile.getAbsolutePath()); - modelFileWriter.apexModelWriteXMLFile(model, AxModel.class, xmlTempFile.getAbsolutePath()); + modelFileWriter.apexModelWriteJsonFile(model, AxModel.class, jsonTempFile.getAbsolutePath()); + modelFileWriter.apexModelWriteXmlFile(model, AxModel.class, xmlTempFile.getAbsolutePath()); jsonTempFile.delete(); xmlTempFile.delete(); @@ -84,7 +80,7 @@ public class TestModelFileWriter { jsonTempFile = new File(tempDir.getAbsolutePath() + "/aaa/bbb/ApexFileWriterTest.xml"); try { - modelFileWriter.apexModelWriteJSONFile(model, AxModel.class, jsonTempFile.getAbsolutePath()); + modelFileWriter.apexModelWriteJsonFile(model, AxModel.class, jsonTempFile.getAbsolutePath()); fail("this test should throw an exception here"); } catch (Exception e) { @@ -92,7 +88,7 @@ public class TestModelFileWriter { } try { - modelFileWriter.apexModelWriteXMLFile(model, AxModel.class, jsonTempFile.getAbsolutePath()); + modelFileWriter.apexModelWriteXmlFile(model, AxModel.class, jsonTempFile.getAbsolutePath()); fail("this test should throw an exception here"); } catch (Exception e) { @@ -110,7 +106,7 @@ public class TestModelFileWriter { jsonTempFile = new File(tempDir.getAbsolutePath() + "/aaa/bbb/ApexFileWriterTest.xml"); try { - modelFileWriter.apexModelWriteJSONFile(model, AxModel.class, jsonTempFile.getAbsolutePath()); + modelFileWriter.apexModelWriteJsonFile(model, AxModel.class, jsonTempFile.getAbsolutePath()); fail("this test should throw an exception here"); } catch (Exception e) { @@ -118,7 +114,7 @@ public class TestModelFileWriter { } try { - modelFileWriter.apexModelWriteXMLFile(model, AxModel.class, jsonTempFile.getAbsolutePath()); + modelFileWriter.apexModelWriteXmlFile(model, AxModel.class, jsonTempFile.getAbsolutePath()); fail("this test should throw an exception here"); } catch (Exception e) { diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestModelReader.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestModelReader.java index 140817e00..1695a0b2c 100644 --- a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestModelReader.java +++ b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestModelReader.java @@ -39,9 +39,6 @@ import org.onap.policy.apex.model.basicmodel.concepts.AxModel; import org.onap.policy.apex.model.basicmodel.handling.ApexModelReader; import org.onap.policy.apex.model.basicmodel.handling.ApexModelWriter; -/** - * @author Liam Fallon (liam.fallon@ericsson.com) - */ public class TestModelReader { @Test @@ -87,12 +84,12 @@ public class TestModelReader { modelWriter.setJsonOutput(false); - ByteArrayOutputStream baosXML = new ByteArrayOutputStream(); - modelWriter.write(model, baosXML); + ByteArrayOutputStream baosXml = new ByteArrayOutputStream(); + modelWriter.write(model, baosXml); - ByteArrayInputStream baisXML = new ByteArrayInputStream(baosXML.toByteArray()); - AxModel readModelXML = modelReader.read(baisXML); - assertEquals(model, readModelXML); + ByteArrayInputStream baisXml = new ByteArrayInputStream(baosXml.toByteArray()); + AxModel readModelXml = modelReader.read(baisXml); + assertEquals(model, readModelXml); String dummyString = "SomeDummyText"; ByteArrayInputStream baisDummy = new ByteArrayInputStream(dummyString.getBytes()); diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestModelSaver.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestModelSaver.java index 08f123cba..634a929d9 100644 --- a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestModelSaver.java +++ b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestModelSaver.java @@ -30,22 +30,20 @@ import org.onap.policy.apex.model.basicmodel.concepts.ApexException; import org.onap.policy.apex.model.basicmodel.concepts.AxModel; import org.onap.policy.apex.model.basicmodel.handling.ApexModelSaver; -/** - * @author Liam Fallon (liam.fallon@ericsson.com) - */ public class TestModelSaver { @Test public void testModelSaver() throws IOException, ApexException { AxModel model = new TestApexBasicModelCreator().getModel(); - + Path tempPath = Files.createTempDirectory("ApexTest"); - - ApexModelSaver modelSaver = new ApexModelSaver(AxModel.class, model, tempPath.toAbsolutePath().toString()); - - modelSaver.apexModelWriteXML(); - modelSaver.apexModelWriteJSON(); - + + ApexModelSaver modelSaver = new ApexModelSaver(AxModel.class, model, + tempPath.toAbsolutePath().toString()); + + modelSaver.apexModelWriteXml(); + modelSaver.apexModelWriteJson(); + Files.deleteIfExists(new File(tempPath.toAbsolutePath() + "/BasicModel.json").toPath()); Files.deleteIfExists(new File(tempPath.toAbsolutePath() + "/BasicModel.xml").toPath()); Files.deleteIfExists(tempPath); diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestModelStringWriter.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestModelStringWriter.java index d2a504676..d187e55ee 100644 --- a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestModelStringWriter.java +++ b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestModelStringWriter.java @@ -33,9 +33,6 @@ import org.onap.policy.apex.model.basicmodel.concepts.AxKeyInfo; import org.onap.policy.apex.model.basicmodel.concepts.AxModel; import org.onap.policy.apex.model.basicmodel.handling.ApexModelStringWriter; -/** - * @author Liam Fallon (liam.fallon@ericsson.com) - */ public class TestModelStringWriter { @Test @@ -43,23 +40,23 @@ public class TestModelStringWriter { AxModel basicModel = new TestApexBasicModelCreator().getModel(); assertNotNull(basicModel); - AxKeyInfo intKI = basicModel.getKeyInformation().get("IntegerKIKey"); - AxKeyInfo floatKI = basicModel.getKeyInformation().get("FloatKIKey"); + AxKeyInfo intKeyInfo = basicModel.getKeyInformation().get("IntegerKIKey"); + AxKeyInfo floatKeyInfo = basicModel.getKeyInformation().get("FloatKIKey"); // Ensure marshalling is OK ApexModelStringWriter stringWriter = new ApexModelStringWriter(true); - assertNotNull(stringWriter.writeJSONString(intKI, AxKeyInfo.class)); - assertNotNull(stringWriter.writeJSONString(floatKI, AxKeyInfo.class)); + assertNotNull(stringWriter.writeJsonString(intKeyInfo, AxKeyInfo.class)); + assertNotNull(stringWriter.writeJsonString(floatKeyInfo, AxKeyInfo.class)); - assertNotNull(stringWriter.writeString(intKI, AxKeyInfo.class, true)); - assertNotNull(stringWriter.writeString(floatKI, AxKeyInfo.class, true)); + assertNotNull(stringWriter.writeString(intKeyInfo, AxKeyInfo.class, true)); + assertNotNull(stringWriter.writeString(floatKeyInfo, AxKeyInfo.class, true)); - assertNotNull(stringWriter.writeString(intKI, AxKeyInfo.class, false)); - assertNotNull(stringWriter.writeString(floatKI, AxKeyInfo.class, false)); + assertNotNull(stringWriter.writeString(intKeyInfo, AxKeyInfo.class, false)); + assertNotNull(stringWriter.writeString(floatKeyInfo, AxKeyInfo.class, false)); - assertNotNull(stringWriter.writeXMLString(intKI, AxKeyInfo.class)); - assertNotNull(stringWriter.writeXMLString(floatKI, AxKeyInfo.class)); + assertNotNull(stringWriter.writeXmlString(intKeyInfo, AxKeyInfo.class)); + assertNotNull(stringWriter.writeXmlString(floatKeyInfo, AxKeyInfo.class)); try { stringWriter.writeString(null, AxKeyInfo.class, true); @@ -78,7 +75,7 @@ public class TestModelStringWriter { } try { - stringWriter.writeJSONString(null, AxKeyInfo.class); + stringWriter.writeJsonString(null, AxKeyInfo.class); fail("test should thrown an exception here"); } catch (Exception e) { @@ -86,7 +83,7 @@ public class TestModelStringWriter { } try { - stringWriter.writeXMLString(null, AxKeyInfo.class); + stringWriter.writeXmlString(null, AxKeyInfo.class); fail("test should thrown an exception here"); } catch (Exception e) { diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestModelWriter.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestModelWriter.java index 8e5af45b3..648194a52 100644 --- a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestModelWriter.java +++ b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestModelWriter.java @@ -33,15 +33,10 @@ import org.onap.policy.apex.model.basicmodel.concepts.ApexException; import org.onap.policy.apex.model.basicmodel.concepts.AxModel; import org.onap.policy.apex.model.basicmodel.handling.ApexModelWriter; -/** - * @author Liam Fallon (liam.fallon@ericsson.com) - */ public class TestModelWriter { @Test public void testModelWriter() throws IOException, ApexException { - AxModel model = new TestApexBasicModelCreator().getModel(); - ApexModelWriter modelWriter = new ApexModelWriter(AxModel.class); modelWriter.setValidateFlag(true); @@ -56,6 +51,8 @@ public class TestModelWriter { ByteArrayOutputStream baos = new ByteArrayOutputStream(); + AxModel model = new TestApexBasicModelCreator().getModel(); + modelWriter.write(model, baos); modelWriter.setJsonOutput(true); modelWriter.write(model, baos); diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestSchemaGenerator.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestSchemaGenerator.java index cdf3b4615..36e4125ec 100644 --- a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestSchemaGenerator.java +++ b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/handling/TestSchemaGenerator.java @@ -31,9 +31,6 @@ import java.io.PrintStream; import org.junit.Test; -/** - * @author Liam Fallon (liam.fallon@ericsson.com) - */ public class TestSchemaGenerator { @Test @@ -83,7 +80,7 @@ public class TestSchemaGenerator { final File tempFile = File.createTempFile("ApexSchemaGeneratorTest", "xsd"); final String[] args5 = - { "org.onap.policy.apex.model.basicmodel.concepts.AxModel", tempFile.getCanonicalPath() }; + { "org.onap.policy.apex.model.basicmodel.concepts.AxModel", tempFile.getCanonicalPath() }; ApexSchemaGenerator.main(args5); assertTrue(tempFile.length() > 100); diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/service/TestModelService.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/service/TestModelService.java index 9c20d837f..4f05de177 100644 --- a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/service/TestModelService.java +++ b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/service/TestModelService.java @@ -29,9 +29,6 @@ import org.junit.Test; import org.onap.policy.apex.model.basicmodel.concepts.AxKeyInformation; import org.onap.policy.apex.model.basicmodel.handling.TestApexBasicModelCreator; -/** - * @author Liam Fallon (liam.fallon@ericsson.com) - */ public class TestModelService { @Test @@ -42,13 +39,12 @@ public class TestModelService { try { ModelService.getModel(AxKeyInformation.class); } catch (final Exception e) { - assertEquals( - "Model for org.onap.policy.apex.model.basicmodel.concepts.AxKeyInformation not found in model service", - e.getMessage()); + assertEquals("Model for org.onap.policy.apex.model.basicmodel.concepts.AxKeyInformation " + + "not found in model service", e.getMessage()); } ModelService.registerModel(AxKeyInformation.class, - new TestApexBasicModelCreator().getModel().getKeyInformation()); + new TestApexBasicModelCreator().getModel().getKeyInformation()); assertTrue(ModelService.existsModel(AxKeyInformation.class)); assertNotNull(ModelService.getModel(AxKeyInformation.class)); @@ -58,13 +54,12 @@ public class TestModelService { try { ModelService.getModel(AxKeyInformation.class); } catch (final Exception e) { - assertEquals( - "Model for org.onap.policy.apex.model.basicmodel.concepts.AxKeyInformation not found in model service", - e.getMessage()); + assertEquals("Model for org.onap.policy.apex.model.basicmodel.concepts.AxKeyInformation " + + "not found in model service", e.getMessage()); } ModelService.registerModel(AxKeyInformation.class, - new TestApexBasicModelCreator().getModel().getKeyInformation()); + new TestApexBasicModelCreator().getModel().getKeyInformation()); assertTrue(ModelService.existsModel(AxKeyInformation.class)); assertNotNull(ModelService.getModel(AxKeyInformation.class)); @@ -73,9 +68,8 @@ public class TestModelService { try { ModelService.getModel(AxKeyInformation.class); } catch (final Exception e) { - assertEquals( - "Model for org.onap.policy.apex.model.basicmodel.concepts.AxKeyInformation not found in model service", - e.getMessage()); + assertEquals("Model for org.onap.policy.apex.model.basicmodel.concepts.AxKeyInformation " + + "not found in model service", e.getMessage()); } } diff --git a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/xml/TestAxReferenceKeyAdapter.java b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/xml/TestAxReferenceKeyAdapter.java index bde0956b8..a7773c37c 100644 --- a/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/xml/TestAxReferenceKeyAdapter.java +++ b/model/basic-model/src/test/java/org/onap/policy/apex/model/basicmodel/xml/TestAxReferenceKeyAdapter.java @@ -27,9 +27,6 @@ import org.junit.Test; import org.onap.policy.apex.model.basicmodel.concepts.AxReferenceKey; import org.onap.policy.apex.model.basicmodel.xml.AxReferenceKeyAdapter; -/** - * @author Liam Fallon (liam.fallon@ericsson.com) - */ public class TestAxReferenceKeyAdapter { @Test @@ -37,10 +34,10 @@ public class TestAxReferenceKeyAdapter { AxReferenceKeyAdapter arka = new AxReferenceKeyAdapter(); assertNotNull(arka); - AxReferenceKey rKey = new AxReferenceKey("Name", "0.0.1", "PLN", "LN"); + AxReferenceKey rkey = new AxReferenceKey("Name", "0.0.1", "PLN", "LN"); - String rKeyString = arka.marshal(rKey); - assertEquals("LN", rKeyString); - assertEquals(rKey.getLocalName(),arka.unmarshal(rKeyString).getLocalName()); + String rkeyString = arka.marshal(rkey); + assertEquals("LN", rkeyString); + assertEquals(rkey.getLocalName(),arka.unmarshal(rkeyString).getLocalName()); } } diff --git a/model/basic-model/src/test/resources/META-INF/persistence.xml b/model/basic-model/src/test/resources/META-INF/persistence.xml index a7bf1f6ac..ffc6526c3 100644 --- a/model/basic-model/src/test/resources/META-INF/persistence.xml +++ b/model/basic-model/src/test/resources/META-INF/persistence.xml @@ -20,11 +20,11 @@ --> - + org.eclipse.persistence.jpa.PersistenceProvider - org.onap.policy.apex.model.basicmodel.dao.converters.CDATAConditioner - org.onap.policy.apex.model.basicmodel.dao.converters.UUID2String + org.onap.policy.apex.model.basicmodel.dao.converters.CDataConditioner + org.onap.policy.apex.model.basicmodel.dao.converters.Uuid2String org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey org.onap.policy.apex.model.basicmodel.concepts.AxReferenceKey org.onap.policy.apex.model.basicmodel.concepts.AxKeyInfo -- cgit 1.2.3-korg