org.corpus_tools.salt.graph.impl.LabelImpl.java Source code

Introduction

Here is the source code for org.corpus_tools.salt.graph.impl.LabelImpl.java

Source

/**
 * Copyright 2009 Humboldt-Universitt zu Berlin, INRIA.
 *
 * 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 org.corpus_tools.salt.graph.impl;

import org.apache.commons.lang3.tuple.Pair;
import org.corpus_tools.salt.exceptions.SaltException;
import org.corpus_tools.salt.graph.Graph;
import org.corpus_tools.salt.graph.Label;
import org.corpus_tools.salt.graph.LabelableElement;
import org.corpus_tools.salt.util.Copyable;
import org.corpus_tools.salt.util.SaltUtil;

@SuppressWarnings("serial")
public class LabelImpl extends LabelableElementImpl implements Label, Copyable<Label> {

    protected String namespace = null;

    /** {@inheritDoc Label#getNamespace()} */
    @Override
    public String getNamespace() {
        return namespace;
    }

    /** {@inheritDoc Label#setNamespace(String)} */
    @Override
    public void setNamespace(String namespace) {
        if (namespace != null) {
            this.namespace = namespace.intern();
        } else {
            this.namespace = null;
        }
    }

    protected String name = null;

    /** {@inheritDoc Label#getName()} */
    @Override
    public String getName() {
        return name;
    }

    /** {@inheritDoc Label#setName(String)} */
    @Override
    public void setName(String name) {
        if ((name == null) || (name.isEmpty())) {
            throw new SaltException("Cannot set the name of this label object, because it is empty.");
        }
        if (name.contains(NS_SEPERATOR)) {
            throw new SaltException(
                    "Cannot set the name to the given, because a namespace with namespace seperaor is illegal.");
        }
        this.name = name.intern();
    }

    /** {@inheritDoc Label#getQName()} */
    @Override
    public String getQName() {
        return SaltUtil.createQName(getNamespace(), getName());
    }

    /** {@inheritDoc Label#setQName(String)} */
    public void setQName(String newQName) {
        Pair<String, String> pair = SaltUtil.splitQName(newQName);
        setNamespace(pair.getLeft());
        setName(pair.getRight());
    }

    /** The generic value field. **/
    protected Object value = null;

    /** {@inheritDoc Label#getValue()} */
    @Override
    public Object getValue() {
        return value;
    }

    /** {@inheritDoc Label#setValue(Object)} */
    @Override
    public void setValue(Object value) {
        this.value = value;
    }

    // ==========================================> container
    /** The container of this object. **/
    protected LabelableElement container = null;

    /** {@inheritDoc} */
    @Override
    public void setContainer(LabelableElement container) {
        LabelableElement oldContainer = this.container;
        if (container != null) {
            // add label to container
            if (container instanceof LabelableElementImpl) {
                container.addLabel(this);
            }

        }
        if (oldContainer != null) {
            // remove label from old container
            if (oldContainer instanceof LabelableElementImpl) {
                ((LabelableElementImpl) oldContainer).basicRemoveLabel(this.getQName());
            }
        }
    }

    /** {@inheritDoc} */
    @Override
    public LabelableElement getContainer() {
        return (container);
    }

    /**
     * This is an internally used method. To implement a double chaining of
     * {@link LabelableElement} and {@link label} object. When a label is
     * inserted into this container and to avoid an endless invocation the
     * insertion of a label is split into the two methods
     * {@link #addLabel(Label)} and {@link #basicAddLabel(Label)}. The
     * invocation of methods is implement as follows:
     * 
     * <pre>
     * {@link #addLabel(Label)}                      {@link Label#setContainer(LabelableElement)}
     *         ||             \ /                   ||
     *         ||              X                    ||
     *         \/             / \                   \/
     * {@link #basicAddLabel(Label)}            {@link LabelImpl#basicSetLabelableElement(LabelableElement)}
     * </pre>
     * 
     * That means method {@link #addLabel(Label)} calls
     * {@link #basicAddLabel(Label)} and {@link Label#basicSetGraph(Graph)}. And
     * method {@link Label#setContainer(LabelableElement)} calls
     * {@link #basicAddLabel(Label)} and
     * {@link LabelImpl#basicSetLabelableElement(LabelableElement)}.
     * 
     * @param label
     *            label to be inserted
     */
    public void basicSetLabelableElement(LabelableElement container) {
        this.container = container;
    }

    // ==========================================< container

    /**
     * This method the namespace, the name and the value from this object to the
     * passed one and returns the passed one.
     * 
     * @param clone
     *            the clone to which all properties of this shall be copied to
     * @return other enhanced for namespace, name and value
     */
    @Override
    public Label copy(Label other) {
        if (other == null) {
            throw new SaltException("Cannot clone label '" + this
                    + "', because the given object is null and its not possible to copy values into a null object.");
        }
        other.setNamespace(this.getNamespace());
        other.setName(this.getName());
        other.setValue(this.getValue());
        return (other);
    }

    @Override
    public String toString() {
        StringBuilder str = new StringBuilder();
        str.append(SaltUtil.createQName(getNamespace(), getName()));
        str.append("=");
        str.append(getValue());
        return (str.toString());
    }
}