AbstractConnector.java

/*
 * This file is part of the OSMembrane project.
 * More informations under www.osmembrane.de
 * 
 * The project is licensed under the GNU GENERAL PUBLIC LICENSE 3.0.
 * for more details about the license see http://www.osmembrane.de/license/
 * 
 * Source: $HeadURL$ ($Revision$)
 * Last changed: $Date$
 */

package de.osmembrane.model.pipeline;

import java.io.Serializable;

/**
 * Represents a {@link AbstractConnector} of a {@link AbstractFunction}.
 * 
 * @author jakob_jarosch
 */
public abstract class AbstractConnector implements Serializable {

    private static final long serialVersionUID = 2011010722200001L;

    /**
     * Type of the connector.
     */
    public enum ConnectorPosition {
        /** Connector is an in connector */
        IN,

        /** Connector is an out connector */
        OUT
    }

    /**
     * Returns the parent, a {@link AbstractFunction}, of the
     * {@link AbstractConnector}.
     * 
     * @return the parent of this connector
     */
    public abstract AbstractFunction getParent();

    /**
     * Returns the localized description of the {@link AbstractConnector}.
     * 
     * @return localized description
     */
    public abstract String getDescription();

    /**
     * Returns the {@link ConnectorType} of the {@link AbstractConnector}.
     * 
     * @return <strike>type of the connector</strike> null
     */
    public abstract ConnectorType getType();

    /**
     * Returns the maximum connections of this connector.
     * 
     * @return the maximum connection count
     */
    public abstract int getMaxConnections();

    /**
     * Returns the "fullness" of the connector.
     * 
     * @return true if the connector is full, otherwise false
     */
    public abstract boolean isFull();

    /**
     * Returns the Connections to other connectors.
     * 
     * @return an array of other {@link AbstractConnector}s to which this
     *         connector is connected.
     */
    public abstract AbstractConnector[] getConnections();

    /**
     * Returns the index of the conenctor.
     * 
     * @return index of the connector
     */
    public abstract int getConnectorIndex();

    /**
     * Creates a connection to another connector.
     * 
     * @param connector
     *            to which a connection should be created
     * 
     * @return true if a connection could be created, otherwise false
     */
    protected abstract boolean addConnection(AbstractConnector connector);

    /**
     * Removes a connection to another connector.
     * 
     * @param connector
     *            from which the connection should be removed
     * 
     * @return true if there was a connection
     */
    protected abstract boolean removeConnection(AbstractConnector connector);

    /**
     * Removes all connections (in both directions).
     * 
     * @param isOutConnector
     *            true if the connector is an out connector
     */
    protected abstract void unlink(boolean isOutConnector);
}