package org.andromda.core.cartridge.template;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.Set;
import org.andromda.core.common.ExceptionUtils;
import org.apache.commons.lang.StringUtils;
/**
* Defines the <modelElements/> element within a <template/> within an XML cartridge descriptor. This allows
* the grouping of model elements by criteria defined within the nested {@link ModelElement}instances.
*
* @author Chad Brandon
* @see Template
* @see ModelElement
*/
public class ModelElements
{
private String variable;
private final Collection modelElements = new ArrayList();
/**
* The variable name to make the model element available to the template engine. For example if you have the
* modelElement <<entity>> defined within your <<modelElements>> element you may want to
* define this value as <code>entity</code>. If on the other hand the outputToSingleFile flag is set to true you'd
* probably want to make it available as <code>entities</code>.
*
* @return Returns the variable.
*/
public String getVariable()
{
return variable;
}
/**
* @param variable The variable to set.
*/
public void setVariable(String variable)
{
variable = StringUtils.trimToEmpty(variable);
ExceptionUtils.checkEmpty("variable", variable);
this.variable = variable;
}
/**
* Adds a modelElement to the collection of <code>modelElements</code>.
*
* @param modelElement the new ModelElement to add.
*/
public void addModelElement(final ModelElement modelElement)
{
ExceptionUtils.checkNull("modelElement", modelElement);
modelElements.add(modelElement);
}
/**
* Gets all metafacade instances from each ModelElement belonging to this ModelElements instance.
*
* @return Collection of all metafacades.
*/
public Set getAllMetafacades()
{
final Set allMetafacades = new LinkedHashSet();
for (final Iterator iterator = this.modelElements.iterator(); iterator.hasNext();)
{
allMetafacades.addAll(((ModelElement)iterator.next()).getMetafacades());
}
return allMetafacades;
}
/**
* Returns all model elements belonging to this model elements instance.
*
* @return Collection of all {@link ModelElement}instances.
*/
public Collection getModelElements()
{
return this.modelElements;
}
/**
* Returns true if this instance has no <code>modelElements</code> stored within it.
*
* @return true/false
*/
public boolean isEmpty()
{
return this.modelElements.isEmpty();
}
}