AssociationEndFacadeLogicImpl.java
package org.andromda.metafacades.uml14;
import java.util.Collection;
import org.andromda.metafacades.uml.ClassifierFacade;
import org.andromda.metafacades.uml.NameMasker;
import org.andromda.metafacades.uml.TypeMappings;
import org.andromda.metafacades.uml.UMLMetafacadeProperties;
import org.andromda.metafacades.uml.UMLMetafacadeUtils;
import org.andromda.metafacades.uml.UMLProfile;
import org.andromda.utils.StringUtilsHelper;
import org.apache.commons.lang.BooleanUtils;
import org.apache.commons.lang.ObjectUtils;
import org.apache.commons.lang.StringUtils;
import org.omg.uml.foundation.core.AssociationEnd;
import org.omg.uml.foundation.core.Classifier;
import org.omg.uml.foundation.core.UmlAssociation;
import org.omg.uml.foundation.datatypes.AggregationKindEnum;
import org.omg.uml.foundation.datatypes.ChangeableKindEnum;
import org.omg.uml.foundation.datatypes.Multiplicity;
import org.omg.uml.foundation.datatypes.MultiplicityRange;
import org.omg.uml.foundation.datatypes.OrderingKind;
import org.omg.uml.foundation.datatypes.OrderingKindEnum;
/**
* Metaclass facade implementation.
* @author Bob Fields
*/
public class AssociationEndFacadeLogicImpl
extends AssociationEndFacadeLogic
{
private static final long serialVersionUID = 34L;
/**
* @param metaObject
* @param context
*/
public AssociationEndFacadeLogicImpl(
org.omg.uml.foundation.core.AssociationEnd metaObject,
String context)
{
super(metaObject, context);
}
/**
* @see org.andromda.core.metafacade.MetafacadeBase#getValidationOwner()
*/
public ClassifierFacade getValidationOwner()
{
return this.getType();
}
/**
* @see org.andromda.metafacades.uml.AssociationEndFacade#getOtherEnd()
*/
@Override
protected AssociationEnd handleGetOtherEnd()
{
final Collection<AssociationEnd> ends = metaObject.getAssociation().getConnection();
for (final AssociationEnd end : ends)
{
if (!metaObject.equals(end))
{
return end;
}
}
return null;
}
/**
* @see org.andromda.metafacades.uml14.ModelElementFacadeLogic#handleGetName()
*/
protected String handleGetName()
{
String name = super.handleGetName();
// if name is empty, then get the name from the type
if (StringUtils.isEmpty(name))
{
final ClassifierFacade type = this.getType();
if (type != null)
{
name = StringUtils.uncapitalize(StringUtils.trimToEmpty(type.getName()));
}
}
if (this.isMany() && this.isPluralizeAssociationEndNames())
{
name = StringUtilsHelper.pluralize(name);
}
final String nameMask =
String.valueOf(this.getConfiguredProperty(UMLMetafacadeProperties.CLASSIFIER_PROPERTY_NAME_MASK));
return NameMasker.mask(
name,
nameMask);
}
/**
* Indicates whether or not we should pluralize association end names.
*
* @return true/false
*/
private boolean isPluralizeAssociationEndNames()
{
final Object value = this.getConfiguredProperty(UMLMetafacadeProperties.PLURALIZE_ASSOCIATION_END_NAMES);
return value != null && Boolean.valueOf(String.valueOf(value));
}
/**
* @return metaObject.getAggregation().toString()
* @see org.andromda.metafacades.uml.AssociationEndFacade#getAggregationKind()
*/
protected String handleGetAggregationKind()
{
return metaObject.getAggregation().toString();
}
/**
* NOT IMPLEMENTED - UML2 only
* @return "" always
* @see org.andromda.metafacades.uml.AssociationEndFacade#getDefault()
*/
protected String handleGetDefault()
{
return "";
}
/**
* @see org.andromda.metafacades.uml.AssociationEndFacade#getType()
*/
@Override
protected Classifier handleGetType()
{
return metaObject.getParticipant();
}
/**
* @see org.andromda.metafacades.uml.AssociationEndFacade#isOne2Many()
*/
@Override
protected boolean handleIsOne2Many()
{
return !this.isMany() && this.getOtherEnd().isMany();
}
/**
* @see org.andromda.metafacades.uml.AssociationEndFacade#isMany2Many()
*/
@Override
protected boolean handleIsMany2Many()
{
return this.isMany() && this.getOtherEnd().isMany();
}
/**
* @see org.andromda.metafacades.uml.AssociationEndFacade#isOne2One()
*/
@Override
protected boolean handleIsOne2One()
{
return !this.isMany() && !this.getOtherEnd().isMany();
}
/**
* @see org.andromda.metafacades.uml.AssociationEndFacade#isMany2One()
*/
@Override
protected boolean handleIsMany2One()
{
return this.isMany() && !this.getOtherEnd().isMany();
}
/**
* @see org.andromda.metafacades.uml.AssociationEndFacade#isMany()
*/
@Override
protected boolean handleIsMany()
{
boolean isMany = false;
final Multiplicity multiplicity = this.metaObject.getMultiplicity();
// we'll say a null multiplicity is 1
if (multiplicity != null)
{
final Collection<MultiplicityRange> ranges = multiplicity.getRange();
if (ranges != null && !ranges.isEmpty())
{
for (MultiplicityRange multiplicityRange : ranges)
{
final int upper = multiplicityRange.getUpper();
isMany = upper > 1 || upper < 0;
}
}
}
if (null!=this.getType() && !isMany)
{
// isCollectionType causes too many problems with the metafacades
isMany = this.getType().isArrayType();
}
return isMany;
}
/**
* UML2 Only: Returns false always.
* @return false
* @see org.andromda.metafacades.uml.AssociationEndFacade#isLeaf()
*/
@Override
public boolean handleIsLeaf()
{
return false;
}
/**
* @see org.andromda.metafacades.uml.AssociationEndFacade#isOrdered()
*/
@Override
protected boolean handleIsOrdered()
{
boolean ordered = false;
final OrderingKind ordering = metaObject.getOrdering();
// no ordering is 'unordered'
if (ordering != null)
{
ordered = ordering.equals(OrderingKindEnum.OK_ORDERED);
}
return ordered;
}
/**
* UML2 Only: Returns false always.
* @return hasStereotype(UMLProfile.STEREOTYPE_UNIQUE)
* @see org.andromda.metafacades.uml.AssociationEndFacade#isUnique()
*/
@Override
public boolean handleIsUnique()
{
return this.hasStereotype(UMLProfile.STEREOTYPE_UNIQUE);
}
/**
* @see org.andromda.metafacades.uml.AssociationEndFacade#isAggregation()
*/
@Override
protected boolean handleIsAggregation()
{
return AggregationKindEnum.AK_AGGREGATE.equals(metaObject.getAggregation());
}
/**
* @see org.andromda.metafacades.uml.AssociationEndFacade#isComposition()
*/
@Override
protected boolean handleIsComposition()
{
return AggregationKindEnum.AK_COMPOSITE.equals(metaObject.getAggregation());
}
/**
* @see org.andromda.metafacades.uml.AssociationEndFacade#isReadOnly()
*/
@Override
protected boolean handleIsReadOnly()
{
return ChangeableKindEnum.CK_FROZEN.equals(metaObject.getChangeability());
}
/**
* @see org.andromda.metafacades.uml.AssociationEndFacade#isNavigable()
*/
@Override
protected boolean handleIsNavigable()
{
return metaObject.isNavigable();
}
/**
* @see org.andromda.metafacades.uml.AssociationEndFacade#getGetterName()
*/
@Override
protected String handleGetGetterName()
{
return UMLMetafacadeUtils.getGetterPrefix(this.getType()) + StringUtilsHelper.capitalize(this.getName());
}
/**
* @see org.andromda.metafacades.uml.AssociationEndFacade#getSetterName()
*/
@Override
protected String handleGetSetterName()
{
return "set" + StringUtils.capitalize(this.getName());
}
/**
* @see org.andromda.metafacades.uml.AssociationEndFacade#getAdderName()
*/
@Override
protected String handleGetAdderName()
{
return "add" + StringUtils.capitalize(this.getName());
}
/**
* @see org.andromda.metafacades.uml.AssociationEndFacade#getRemoverName()
*/
@Override
protected String handleGetRemoverName()
{
return "remove" + StringUtils.capitalize(this.getName());
}
/**
* @see org.andromda.metafacades.uml.AssociationEndFacade#isBindingDependenciesPresent()
*/
@Override
protected boolean handleIsBidirectional()
{
return isNavigable() && getOtherEnd().isNavigable();
}
/**
* @see org.andromda.metafacades.uml.AssociationEndFacade#getAssociation()
*/
@Override
protected UmlAssociation handleGetAssociation()
{
return metaObject.getAssociation();
}
/**
* @see org.andromda.metafacades.uml.AssociationEndFacade#getGetterSetterTypeName()
*/
@Override
protected String handleGetGetterSetterTypeName()
{
String name = null;
if (this.isMany() && this.getType()!=null && !this.getType().isArrayType() && !this.getType().isCollectionType())
{
final TypeMappings mappings = this.getLanguageMappings();
if (mappings != null)
{
name =
this.isOrdered() ? mappings.getTo(UMLProfile.LIST_TYPE_NAME)
: mappings.getTo(UMLProfile.COLLECTION_TYPE_NAME);
}
// set this association end's type as a template parameter if required
if (BooleanUtils.toBoolean(
ObjectUtils.toString(this.getConfiguredProperty(UMLMetafacadeProperties.ENABLE_TEMPLATING)))
&& this.getType() != null)
{
String type = this.getType().getFullyQualifiedName();
/*Collection<GeneralizableElementFacade> specializations = this.getType().getAllSpecializations();
if ((specializations != null && !specializations.isEmpty()))
{
name += "<? extends " + type + '>';
}
else
{*/
name += '<' + type + '>';
//}
}
}
if (name == null && this.getType() != null)
{
name = this.getType().getFullyQualifiedName();
}
return name;
}
/**
* @see org.andromda.metafacades.uml.AssociationEndFacade#isRequired()
*/
@Override
protected boolean handleIsRequired()
{
final int lower = this.getMultiplicityRangeLower();
return lower >= 1;
}
/**
* @see org.andromda.metafacades.uml.AssociationEndFacade#isChild()
*/
@Override
protected boolean handleIsChild()
{
return this.getOtherEnd() != null && this.getOtherEnd().isComposition();
}
/**
* Returns the upper range of the multiplicity for the passed in attribute
*
* @return int the upper range of the multiplicity or 1 if it isn't defined.
*/
private int getMultiplicityRangeUpper()
{
Integer upper = null;
final Multiplicity multiplicity = metaObject.getMultiplicity();
if (multiplicity != null)
{
final Collection<MultiplicityRange> ranges = multiplicity.getRange();
if (ranges != null)
{
for (MultiplicityRange multiplicityRange : ranges)
{
upper = Integer.valueOf(multiplicityRange.getUpper());
}
}
}
if (upper == null)
{
upper = Integer.valueOf(1);
}
return upper.intValue();
}
/**
* Returns the lower range of the multiplicity for the passed in associationEnd
*
* @return int the lower range of the multiplicity or 1 if it isn't defined.
*/
private int getMultiplicityRangeLower()
{
Integer lower = null;
final Multiplicity multiplicity = this.metaObject.getMultiplicity();
if (multiplicity != null)
{
final Collection<MultiplicityRange> ranges = multiplicity.getRange();
if (ranges != null)
{
for (MultiplicityRange multiplicityRange : ranges)
{
lower = Integer.valueOf(multiplicityRange.getLower());
}
}
}
if (lower == null)
{
final String defaultMultiplicity = this.getDefaultMultiplicity();
if (defaultMultiplicity.startsWith("0"))
{
lower = Integer.valueOf(0);
}
else
{
lower = Integer.valueOf(1);
}
}
return lower.intValue();
}
/**
* Gets the default multiplicity for this attribute (the
* multiplicity if none is defined).
*
* @return the default multiplicity as a String.
*/
private String getDefaultMultiplicity()
{
return ObjectUtils.toString(this.getConfiguredProperty(UMLMetafacadeProperties.DEFAULT_MULTIPLICITY));
}
/**
* Get the UML upper multiplicity
* Not implemented for UML1.4
*/
@Override
protected int handleGetUpper()
{
return this.getMultiplicityRangeUpper();
}
/**
* Get the UML lower multiplicity
*/
@Override
protected int handleGetLower()
{
return this.getMultiplicityRangeLower();
}
/**
* @see org.andromda.metafacades.uml14.AssociationEndFacadeLogic#handleIsDerived()
*/
@Override
protected boolean handleIsDerived()
{
// UML 1.4 does not have derived association ends.
return false;
}
/**
* UML2 only. Can't determine association scope in UML14.
* @see org.andromda.metafacades.uml.AttributeFacade#isStatic()
*/
@Override
public boolean handleIsStatic()
{
return false;
}
}