path: root/model/src/main/java/org/onap/policy/apex/model/eventmodel/concepts/AxField.java

/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
 *  Modifications Copyright (C) 2019,2022 Nordix Foundation.
 *  Modifications Copyright (C) 2021 AT&T Intellectual Property. 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.eventmodel.concepts;

import java.util.List;
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.AxKey;
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.AxValidationMessage;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
import org.onap.policy.common.utils.validation.Assertions;

/**
 * In Apex, a field is an input or output parameter to or from a concept. For example, the parameters of an event are
 * fields and the input and output of a task is defined as a collection of fields.
 *
 * <p>A field has an {@link AxReferenceKey} key that defines its name and parent, and a {@link AxArtifactKey} key to a
 * context schema that defines the structure of the data atom that holds the value of the field. Fields can be specified
 * as being optional but are mandatory by default.
 *
 * <p>Validation checks that the field key and the field schema reference key are not null.
 */
public class AxField extends AxConcept {
    private static final String KEY_MAY_NOT_BE_NULL = "key may not be null";
    private static final String FIELD_SCHEMA_KEY_MAY_NOT_BE_NULL = "fieldSchemaKey may not be null";

    private static final long serialVersionUID = -6443016863162692288L;

    private static final int HASH_PRIME_0 = 1231;
    private static final int HASH_PRIME_1 = 1237;

    private AxReferenceKey key;
    private AxArtifactKey fieldSchemaKey;
    private boolean optional;

    /**
     * The default constructor creates a field with a null artifact and schema key.
     */
    public AxField() {
        this(new AxReferenceKey());
        optional = false;
    }

    /**
     * The default constructor creates a field with the given artifact key and a null schema key.
     *
     * @param key the field key
     */
    public AxField(final AxReferenceKey key) {
        this(key, new AxArtifactKey());
    }

    /**
     * Copy constructor.
     *
     * @param copyConcept the concept to copy from
     */
    public AxField(final AxField copyConcept) {
        super(copyConcept);
    }

    /**
     * Constructor to create the field with both its keys defined.
     *
     * @param key the field key
     * @param fieldSchemaKey the key of the field schema to use for this field
     */
    public AxField(final AxReferenceKey key, final AxArtifactKey fieldSchemaKey) {
        super();
        Assertions.argumentNotNull(key, KEY_MAY_NOT_BE_NULL);
        Assertions.argumentNotNull(fieldSchemaKey, FIELD_SCHEMA_KEY_MAY_NOT_BE_NULL);

        this.key = key;
        this.fieldSchemaKey = fieldSchemaKey;
    }

    /**
     * Constructor to create the field with all its fields defined.
     *
     * @param key the field key
     * @param fieldSchemaKey the key of the field schema to use for this field
     * @param optional true if this field is optional
     */
    public AxField(final AxReferenceKey key, final AxArtifactKey fieldSchemaKey, final boolean optional) {
        super();
        Assertions.argumentNotNull(key, KEY_MAY_NOT_BE_NULL);
        Assertions.argumentNotNull(fieldSchemaKey, FIELD_SCHEMA_KEY_MAY_NOT_BE_NULL);

        this.key = key;
        this.fieldSchemaKey = fieldSchemaKey;
        this.optional = optional;
    }

    /**
     * Constructor to create the field with the local name of its reference key defined and its schema key defined.
     *
     * @param localName the local name of the field reference key
     * @param fieldSchemaKey the key of the field schema to use for this field
     */
    public AxField(final String localName, final AxArtifactKey fieldSchemaKey) {
        super();
        Assertions.argumentNotNull(localName, "localName may not be null");
        Assertions.argumentNotNull(fieldSchemaKey, FIELD_SCHEMA_KEY_MAY_NOT_BE_NULL);

        key = new AxReferenceKey();
        key.setLocalName(localName);
        this.fieldSchemaKey = fieldSchemaKey;
    }

    /**
     * Constructor to create the field with the local name of its reference key defined, its schema key and optionality
     * defined.
     *
     * @param localName the local name of the field reference key
     * @param fieldSchemaKey the key of the field schema to use for this field
     * @param optional true if this field is optional
     */
    public AxField(final String localName, final AxArtifactKey fieldSchemaKey, final boolean optional) {
        super();
        Assertions.argumentNotNull(localName, "localName may not be null");
        Assertions.argumentNotNull(fieldSchemaKey, FIELD_SCHEMA_KEY_MAY_NOT_BE_NULL);

        key = new AxReferenceKey();
        key.setLocalName(localName);
        this.fieldSchemaKey = fieldSchemaKey;
        this.optional = optional;
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public AxReferenceKey getKey() {
        return key;
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public List<AxKey> getKeys() {
        final List<AxKey> keyList = key.getKeys();
        keyList.add(new AxKeyUse(fieldSchemaKey));
        return keyList;
    }

    /**
     * Sets the reference key of the field.
     *
     * @param key the field reference key
     */
    public void setKey(final AxReferenceKey key) {
        Assertions.argumentNotNull(key, KEY_MAY_NOT_BE_NULL);
        this.key = key;
    }

    /**
     * Gets the key of the field schema.
     *
     * @return the field schema key
     */
    public AxArtifactKey getSchema() {
        return fieldSchemaKey;
    }

    /**
     * Sets the key of the field schema.
     *
     * @param schema the field schema key
     */
    public void setSchema(final AxArtifactKey schema) {
        Assertions.argumentNotNull(schema, "schema may not be null");
        this.fieldSchemaKey = schema;
    }

    /**
     * Gets the optionality of the field.
     *
     * @return the field optional flag
     */
    public boolean getOptional() {
        return optional;
    }

    /**
     * Sets the optionality of the field.
     *
     * @param optional the optionality of the field
     */
    public void setOptional(final boolean optional) {
        this.optional = optional;
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public AxValidationResult validate(final AxValidationResult resultIn) {
        AxValidationResult result = resultIn;

        if (key.equals(AxReferenceKey.getNullKey())) {
            result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID,
                            "key is a null key"));
        }

        result = key.validate(result);

        if (fieldSchemaKey.equals(AxArtifactKey.getNullKey())) {
            result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID,
                            "fieldSchemaKey is a null key: " + fieldSchemaKey));
        }
        return fieldSchemaKey.validate(result);
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public void clean() {
        key.clean();
        fieldSchemaKey.clean();
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public String toString() {
        final StringBuilder builder = new StringBuilder();
        builder.append(this.getClass().getSimpleName());
        builder.append(":(");
        builder.append("key=");
        builder.append(key);
        builder.append(",fieldSchemaKey=");
        builder.append(fieldSchemaKey);
        builder.append(",optional=");
        builder.append(optional);
        builder.append(")");
        return builder.toString();
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public AxConcept copyTo(final AxConcept targetObject) {
        Assertions.argumentNotNull(targetObject, "target may not be null");

        final Object copyObject = targetObject;
        Assertions.instanceOf(copyObject, AxField.class);

        final AxField copy = ((AxField) copyObject);
        copy.setKey(new AxReferenceKey(key));
        copy.setSchema(new AxArtifactKey(fieldSchemaKey));
        copy.setOptional(optional);
        return copy;
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result + key.hashCode();
        result = prime * result + fieldSchemaKey.hashCode();
        result = prime * result + (optional ? HASH_PRIME_0 : HASH_PRIME_1);
        return result;
    }

    /*
     * (nonJavadoc)
     *
     * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#equals(java.lang.Object)
     */
    @Override
    public boolean equals(final Object obj) {
        if (obj == null) {
            return false;
        }
        if (this == obj) {
            return true;
        }

        if (!(obj instanceof AxField)) {
            return false;
        }

        final AxField other = (AxField) obj;
        if (!key.getLocalName().equals(other.key.getLocalName())) {
            return false;
        }
        if (optional != other.optional) {
            return false;
        }
        return fieldSchemaKey.equals(other.fieldSchemaKey);
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public int compareTo(final AxConcept otherObj) {
        if (otherObj == null) {
            return 1;
        }
        if (this == otherObj) {
            return 0;
        }
        if (!(otherObj instanceof AxField)) {
            return this.hashCode() - otherObj.hashCode();
        }

        final AxField other = (AxField) otherObj;
        if (!key.getLocalName().equals(other.key.getLocalName())) {
            return key.getLocalName().compareTo(other.key.getLocalName());
        }
        if (optional != other.optional) {
            return (optional ? 1 : -1);
        }
        return fieldSchemaKey.compareTo(other.fieldSchemaKey);
    }
}