ca.mcgill.cs.swevo.jayfx.model.AbstractElement.java Source code

Introduction

Here is the source code for ca.mcgill.cs.swevo.jayfx.model.AbstractElement.java

Source

/* JayFX - A Fact Extractor Plug-in for Eclipse
 * Copyright (C) 2006  McGill University (http://www.cs.mcgill.ca/~swevo/jayfx)
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * $Revision: 1.4 $
 */

package ca.mcgill.cs.swevo.jayfx.model;

import org.jdom2.*;

/**
 * Abtract class for the various program elements in the model.
 */
public abstract class AbstractElement implements IElement {
    private String aId = "java.lang.Object";

    /**
     * Builds an abstract element.
     * 
     * @param pId
     *            The id uniquely identifying the element. This id consists in
     *            the fully-qualified name of a class element, the field name
     *            appended to the fully-qualified named of the declaring class
     *            for fields, and the name and signature appended to the
     *            fully-qualified name of the declaring class for methods.
     */
    protected AbstractElement(final String pId) {
        if (pId != null)
            this.aId = pId;
    }

    /**
     * This method must be redeclared here for compatibility with the IElement
     * interface. Returns the category of the element within the general model.
     * 
     * @return An int representing the category of the element.
     * @see ca.ubc.cs.javadb.model.IElement#getCategory()
     */
    @Override
    public abstract Category getCategory();

    /**
     * This method must be redeclared here for compatibility with the IElement
     * interface. Returns the unique (fully qualified) name of the element.
     * 
     * @return A String representing the fully qualified name of the element.
     * @see ca.ubc.cs.javadb.model.IElement#getId()
     */
    @Override
    public String getId() {
        return this.aId;
    }

    public void setId(String val) {
        this.aId = val;
    }

    /**
     * @return The id of this element without the package.
     */
    @Override
    public abstract String getShortName();

    /**
     * Returns a String representation of the element.
     * 
     * @return The element's ID.
     */
    @Override
    public String toString() {
        return this.getId();
    }

    @Override
    public Element getXML() {
        Element ret = new Element(IElement.class.getSimpleName());
        ret.setAttribute(new Attribute(IElement.ID, this.getId()));
        ret.addContent(this.getCategory().getXML());
        return ret;
    }
}