All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • uk.gov.gchq.gaffer.data.element.ElementTuple Maven / Gradle / Ivy

    /*
 * Copyright 2016-2019 Crown Copyright
 *
 * 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.
 */

package uk.gov.gchq.gaffer.data.element;

import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;

import uk.gov.gchq.gaffer.commonutil.ToStringBuilder;
import uk.gov.gchq.koryphe.tuple.Tuple;

/**
 * An {@code ElementTuple} implements {@link Tuple} wrapping an
 * {@link Element} and providing a getter and setter for the element's identifiers and properties.
 * This class allows Elements to be used with the function module whilst minimising dependencies.
 */
public class ElementTuple implements Tuple {
    public static final String ELEMENT = "ELEMENT";
    public static final String PROPERTIES = "PROPERTIES";

    private Element element;

    public ElementTuple() {
    }

    public ElementTuple(final Element element) {
        this.element = element;
    }

    public Element getElement() {
        return element;
    }

    public void setElement(final Element element) {
        this.element = element;
    }

    @Override
    public Object get(final String reference) {
        if (ELEMENT.equals(reference)) {
            return element;
        }

        if (PROPERTIES.equals(reference)) {
            return element.getProperties();
        }

        final IdentifierType idType = IdentifierType.fromName(reference);
        if (null == idType) {
            return element.getProperty(reference);
        }

        return element.getIdentifier(idType);
    }

    @Override
    public Iterable values() {
        throw new UnsupportedOperationException("Calling values() is not supported for ElementTuples");
    }

    @Override
    public void put(final String reference, final Object value) {
        if (ELEMENT.equals(reference)) {
            throw new IllegalArgumentException("You are not allowed to set an entire Element on this ElementTuple");
        }

        if (PROPERTIES.equals(reference)) {
            element.copyProperties(((Properties) value));
        }

        final IdentifierType idType = IdentifierType.fromName(reference);

        if (null == idType) {
            element.putProperty(reference, value);
        } else {
            element.putIdentifier(idType, value);
        }
    }

    @Override
    public boolean equals(final Object obj) {
        if (this == obj) {
            return true;
        }

        if (null == obj || getClass() != obj.getClass()) {
            return false;
        }

        final ElementTuple objects = (ElementTuple) obj;

        return new EqualsBuilder()
                .append(element, objects.element)
                .isEquals();
    }

    @Override
    public int hashCode() {
        return new HashCodeBuilder(61, 5)
                .append(element)
                .toHashCode();
    }

    @Override
    public String toString() {
        return new ToStringBuilder(this)
                .append("element", element)
                .toString();
    }
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy