LogicalRelationshipAspect.java

/*
 * JBoss, Home of Professional Open Source.
 *
 * See the LEGAL.txt file distributed with this work for information regarding copyright ownership and licensing.
 *
 * See the AUTHORS.txt file distributed with this work for a full listing of individual contributors.
 */
package org.teiid.designer.metamodels.relational.aspects.uml;

import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.emf.ecore.EObject;
import org.teiid.core.designer.TeiidDesignerRuntimeException;
import org.teiid.core.designer.util.CoreArgCheck;
import org.teiid.core.designer.util.CoreStringUtil;
import org.teiid.designer.core.metamodel.aspect.MetamodelEntity;
import org.teiid.designer.core.metamodel.aspect.uml.UmlAssociation;
import org.teiid.designer.metamodels.relational.LogicalRelationship;
import org.teiid.designer.metamodels.relational.LogicalRelationshipEnd;
import org.teiid.designer.metamodels.relational.MultiplicityKind;
import org.teiid.designer.metamodels.relational.RelationalMetamodelConstants;
import org.teiid.designer.metamodels.relational.RelationalPlugin;


/**
 * ForeignKeyAspect
 *
 * @since 8.0
 */
public class LogicalRelationshipAspect extends RelationalEntityAspect implements UmlAssociation {
    /**
     * Construct an instance of ForeignKeyAspect.
     * 
     * @param entity
     */
    public LogicalRelationshipAspect( MetamodelEntity entity ) {
        super();
        setMetamodelEntity(entity);
    }

    /* (non-Javadoc)
     * @See org.teiid.designer.core.metamodels.aspects.UmlAssociation#getAggregation(java.lang.Object, int)
     */
    @Override
	public int getAggregation( Object assoc,
                               int end ) {
        return AGGREGATION_NONE;
    }

    /* (non-Javadoc)
     * @See org.teiid.designer.core.metamodels.aspects.UmlDiagramAspect#getStereotype(java.lang.Object)
     */
    @Override
	public String getStereotype( Object eObject ) {
        return RelationalPlugin.getPluginResourceLocator().getString("_UI_LogicalRelationship_type"); //$NON-NLS-1$
    }

    @Override
	public int getEndCount( Object assoc ) {
        final LogicalRelationship lr = assertLogicalRelationship(assoc);
        return lr.getEnds().size();
    }

    @Override
	public EObject getEndTarget( Object assoc,
                                 int end ) {
        final LogicalRelationship lr = assertLogicalRelationship(assoc);
        if (end < 0 || end >= lr.getEnds().size()) {
            return null;
        }
        final LogicalRelationshipEnd lre = (LogicalRelationshipEnd)lr.getEnds().get(end);
        return lre.getTable();
    }

    @Override
	public EObject getEnd( Object assoc,
                           int end ) {
        final LogicalRelationship lr = assertLogicalRelationship(assoc);
        if (end < 0 || end >= lr.getEnds().size()) {
            return null;
        }
        final LogicalRelationshipEnd lre = (LogicalRelationshipEnd)lr.getEnds().get(end);
        return lre;
    }

    @Override
	public String getEditableSignature( Object eObject ) {
        return getSignature(eObject, UmlAssociation.SIGNATURE_NAME);
    }

    @Override
	public String getSignature( Object eObject,
                                int showMask ) {
        final LogicalRelationship lr = assertLogicalRelationship(eObject);
        StringBuffer result = new StringBuffer();
        switch (showMask) {
            case 1:
                // Name
                result.append(lr.getName());
                break;
            case 2:
                // Stereotype
                result.append("<<"); //$NON-NLS-1$
                result.append(getStereotype(eObject));
                result.append(">>"); //$NON-NLS-1$
                break;
            case 3:
                // Name and Stereotype
                result.append("<<"); //$NON-NLS-1$
                result.append(getStereotype(eObject));
                result.append(">> "); //$NON-NLS-1$
                result.append(lr.getName());
                break;
            case 4:
                // Return properties
                result.append(super.getArrayAsString(getProperties(lr, 0)));
                break;
            case 5:
                // Name and properties
                result.append(lr.getName());
                result.append(super.getArrayAsString(getProperties(lr, 0)));
                break;
            case 6:
                // Return Properties and Stereotype
                result.append("<<"); //$NON-NLS-1$
                result.append(getStereotype(eObject));
                result.append(">> "); //$NON-NLS-1$
                result.append(super.getArrayAsString(getProperties(lr, 0)));
                break;
            case 7:
                // Name, Stereotype and Properties
                result.append("<<"); //$NON-NLS-1$
                result.append(getStereotype(eObject));
                result.append(">> "); //$NON-NLS-1$
                result.append(lr.getName());
                result.append(super.getArrayAsString(getProperties(lr, 0)));
                break;
            default:
                throw new TeiidDesignerRuntimeException(RelationalPlugin.Util.getString("Aspect.invalidShowMask", showMask)); //$NON-NLS-1$
        }
        return result.toString();
    }

    /* (non-Javadoc)
     * @See org.teiid.designer.core.metamodels.aspects.UmlDiagramAspect#setSignature(java.lang.Object, java.lang.String)
     */
    @Override
	public IStatus setSignature( Object eObject,
                                 String newSignature ) {
        try {
            final LogicalRelationship lr = assertLogicalRelationship(eObject);
            lr.setName(newSignature);
        } catch (Throwable e) {
            return new Status(IStatus.ERROR, RelationalMetamodelConstants.PLUGIN_ID, 0, e.getMessage(), e);
        }

        return new Status(IStatus.OK, RelationalMetamodelConstants.PLUGIN_ID, 0,
                          RelationalPlugin.Util.getString("Aspect.ok"), null); //$NON-NLS-1$
    }

    /* (non-Javadoc)
     * @See org.teiid.designer.core.metamodels.aspects.UmlAssociation#getNavigability(java.lang.Object, int)
     */
    @Override
	public int getNavigability( Object assoc,
                                int end ) {
        assertLogicalRelationship(assoc);
        return NAVIGABILITY_NAVIGABLE;
    }

    /* (non-Javadoc)
     * @See org.teiid.designer.core.metamodels.aspects.UmlAssociation#setNavigability(java.lang.Object, int, int)
     */
    @Override
	public IStatus setNavigability( Object assoc,
                                    int end,
                                    int navigability ) {
        throw new UnsupportedOperationException();
    }

    @Override
	public String getRoleName( Object assoc,
                               int end ) {
        final LogicalRelationship lr = assertLogicalRelationship(assoc);
        if (end < 0 || end >= lr.getEnds().size()) {
            return null;
        }

        LogicalRelationshipEnd lrEnd = (LogicalRelationshipEnd)lr.getEnds().get(end);
        return lrEnd.getName();
    }

    /* (non-Javadoc)
     * @See org.teiid.designer.core.metamodels.aspects.UmlAssociation#setRoleName(java.lang.Object, int, java.lang.String)
     */
    @Override
	public IStatus setRoleName( Object assoc,
                                int end,
                                String name ) {
        throw new UnsupportedOperationException();
    }

    @Override
	public String getMultiplicity( Object eObject,
                                   int end ) {
        final LogicalRelationship lr = assertLogicalRelationship(eObject);
        if (end < 0 || end >= lr.getEnds().size()) {
            return null;
        }
        final LogicalRelationshipEnd lre = (LogicalRelationshipEnd)lr.getEnds().get(end);
        return lre.getMultiplicity().getName();
    }

    /* (non-Javadoc)
     * @See org.teiid.designer.core.metamodels.aspects.UmlAssociation#setMultiplicity(java.lang.Object, int, java.lang.String)
     */
    @Override
	public IStatus setMultiplicity( Object assoc,
                                    int end,
                                    String mult ) {
        final LogicalRelationship lr = assertLogicalRelationship(assoc);
        if (end < 0 || end >= lr.getEnds().size()) {
            return new Status(IStatus.OK, RelationalMetamodelConstants.PLUGIN_ID, 0,
                              RelationalPlugin.Util.getString("KeyAspect.Invalid_end"), null); //$NON-NLS-1$
        }
        final LogicalRelationshipEnd lre = (LogicalRelationshipEnd)lr.getEnds().get(end);
        MultiplicityKind value = MultiplicityKind.get(mult);
        if (value != null) {
            lre.setMultiplicity(value);
            return new Status(IStatus.OK, RelationalMetamodelConstants.PLUGIN_ID, 0,
                              RelationalPlugin.Util.getString("Aspect.ok"), null); //$NON-NLS-1$
        }
        return new Status(IStatus.OK, RelationalMetamodelConstants.PLUGIN_ID, 0,
                          RelationalPlugin.Util.getString("KeyAspect.Invalid_end"), null); //$NON-NLS-1$
    }

    /* (non-Javadoc)
     * @See org.teiid.designer.core.metamodels.aspects.UmlAssociation#getProperties(java.lang.Object, int)
     */
    @Override
	public String[] getProperties( Object assoc,
                                   int end ) {
        return CoreStringUtil.Constants.EMPTY_STRING_ARRAY;
    }

    /* (non-Javadoc)
     * @See org.teiid.designer.core.metamodels.aspects.UmlAssociation#setProperties(java.lang.Object, int, java.lang.String)
     */
    @Override
	public IStatus setProperties( Object assoc,
                                  int end,
                                  String[] props ) {
        throw new UnsupportedOperationException();
    }

    protected LogicalRelationshipEnd assertLogicalRelationshipEnd( Object eObject ) { // NO_UCD
        CoreArgCheck.isInstanceOf(LogicalRelationshipEnd.class, eObject);

        return (LogicalRelationshipEnd)eObject;
    }

    /**
     * @see org.teiid.designer.core.metamodel.aspect.uml.UmlRelationship#getName(java.lang.Object)
     */
    @Override
	public String getName( Object eObject ) {
        return CoreStringUtil.Constants.EMPTY_STRING;
    }

    /**
     * @see org.teiid.designer.core.metamodel.aspect.uml.UmlRelationship#getToolTip(java.lang.Object)
     */
    @Override
	public String getToolTip( Object eObject ) {
        final StringBuffer sb = new StringBuffer(200);
        sb.append(this.getStereotype(eObject));
        return sb.toString();
    }

    protected LogicalRelationship assertLogicalRelationship( Object eObject ) {
        CoreArgCheck.isInstanceOf(LogicalRelationship.class, eObject);

        return (LogicalRelationship)eObject;
    }
}