ru.curs.celesta.score.NamedElementHolder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of celesta-core Show documentation
The newest version!
package ru.curs.celesta.score;

import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.Map;

/**
 * A collection of named elements that may only contain one element per each name.
 * Provides uniqueness of names and access by name. For example these may be tables
 * in a grain, fields in a key etc.
 *
 * The implementation of interface Collection is done only for the purpose of
 * ObjectAid utility to correctly build a UML diagram (taking a field of
 * NamedElementHolder type as a multi-reference).
 *
 *
 * @param   type of named elements in the collection.
 */
public abstract class NamedElementHolder implements Collection {
    private final LinkedHashMap namespace = new LinkedHashMap<>();
    private final Map namespaceReadOnly = Collections.unmodifiableMap(namespace);

    /**
     * Returns a copy of elements map only for reading.
     *
     * @return
     */
    public Map getElements() {
        return namespaceReadOnly;
    }

    protected abstract String getErrorMsg(String name);

    /**
     * Adds a named element.
     *
     * @param element  element to add
     * @throws ParseException  if an element with the same name already exists.
     */
    public final void addElement(T element) throws ParseException {
        T oldValue = namespace.put(element.getName(), element);
        if (oldValue != null) {
            namespace.put(oldValue.getName(), oldValue);
            throw new ParseException(getErrorMsg(element.getName()));
        }
    }

    /**
     * Returns element by name.
     *
     * @param name  element name (identifier)
     * @return
     */
    public final T get(String name) {
        return namespace.get(name);
    }

    /**
     * Returns index of element by name.
     *
     * @param name  element name (identifier)
     * @return
     */
    public final int getIndex(String name) {
        int i = -1;
        for (String c : namespace.keySet()) {
            i++;
            if (c.equals(name)) {
                return i;
            }
        }
        return i;
    }

    @Override
    public final boolean isEmpty() {
        return namespace.isEmpty();
    }

    @Override
    public final Iterator iterator() {
        return namespace.values().iterator();
    }

    @Override
    public final int size() {
        return namespace.size();
    }

    @Override
    public final boolean contains(Object o) {
        return namespace.containsValue(o);
    }

    @Override
    public final Object[] toArray() {
        return namespace.values().toArray();
    }

    @Override
    public final  A[] toArray(A[] a) {
        return namespace.values().toArray(a);
    }

    @Override
    @Deprecated
    public final boolean add(T e) {
        throw new UnsupportedOperationException();
    }

    @Override
    public final boolean remove(Object o) {
        if (o instanceof NamedElement) {
            NamedElement e = (NamedElement) o;
            return namespace.remove(e.getName()) != null;
        } else {
            return false;
        }
    }

    @Override
    public final boolean containsAll(Collection c) {
        throw new UnsupportedOperationException();
    }

    @Override
    public final boolean addAll(Collection c) {
        throw new UnsupportedOperationException();
    }

    @Override
    public final boolean removeAll(Collection c) {
        throw new UnsupportedOperationException();
    }

    @Override
    public final boolean retainAll(Collection c) {
        throw new UnsupportedOperationException();
    }

    @Override
    public final void clear() {
        namespace.clear();
    }

}