org.geomajas.layer.feature.attribute.OneToManyAttribute Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of geomajas-api Show documentation
Geomajas server: Main - api
There is a newer version: 1.18.5
/*
 * This is part of Geomajas, a GIS framework, http://www.geomajas.org/.
 *
 * Copyright 2008-2015 Geosparc nv, http://www.geosparc.com/, Belgium.
 *
 * The program is available in open source according to the GNU Affero
 * General Public License. All contributions in this program are covered
 * by the Geomajas Contributors License Agreement. For full licensing
 * details, see LICENSE.txt in the project root.
 */

package org.geomajas.layer.feature.attribute;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import org.geomajas.annotation.Api;
import org.geomajas.configuration.AssociationType;

/**
 * 
 * Definition of the one-to-many association attribute. This type of attribute is not a simple primitive attribute with
 * a single value, but instead holds the values of an entire list of beans. This list of bean values has been defined in
 * the form of a list of {@link AssociationValue} objects.
 * 
 * 
 * @author Pieter De Graef
 * @since 1.6.0
 */
@Api(allMethods = true)
public class OneToManyAttribute extends AssociationAttribute> {

	private static final long serialVersionUID = 154L;

	private List value;

	// Constructors:

	/**
	 * Create attribute without value (needed for GWT).
	 */
	public OneToManyAttribute() {
		super();
	}

	/**
	 * Create attribute with specified value.
	 * 
	 * @param value
	 *            value for attribute
	 */
	public OneToManyAttribute(List value) {
		this.value = value;
	}

	/**
	 * {@inheritDoc}
	 */
	public AssociationType getType() {
		return AssociationType.ONE_TO_MANY;
	}

	/**
	 * {@inheritDoc}
	 */
	public List getValue() {
		return value;
	}

	/**
	 * {@inheritDoc}
	 */
	public boolean isEmpty() {
		return value == null;
	}

	/**
	 * {@inheritDoc}
	 */
	public void setValue(List value) {
		this.value = value;
	}

	/**
	 * Create a clone of this attribute object.
	 * 
	 * @since 1.7.0
	 * @return A copy of this ManyToOne attribute.
	 */
	@edu.umd.cs.findbugs.annotations.SuppressWarnings(value = "CN_IDIOM_NO_SUPER_CALL",
			justification = "needed for GWT")
	public Object clone() { // NOSONAR super.clone() not supported by GWT
		OneToManyAttribute clone = new OneToManyAttribute();
		if (value != null) {
			List clones = new ArrayList();
			for (AssociationValue v : value) {
				clones.add((AssociationValue) v.clone());
			}
			clone.setValue(clones);
		}
		clone.setEditable(isEditable());
		return clone;
	}
	
	/**
	 * Returns a string representation of this attributes value of the form
	 * [{id=1, attr1=a}, {id=2, attr1=b}].
	 * 
	 * @return string value
	 * @since 1.9.0
	 * @see AssociationValue#toString()
	 */
	@Override
	public String toString() {
		if (value != null) {
			Iterator it = value.iterator();
			StringBuilder builder = new StringBuilder("[");
			while (it.hasNext()) {
				AssociationValue part = it.next();
				builder.append(part.toString());
				if (it.hasNext()) {
					builder.append(", ");
				}
			}
			builder.append("]");
			return builder.toString();
		} else {
			return "null";
		}
	}

}