ContainerUnloader.java

/*
 Copyright 2008-2010 Gephi
 Authors : Mathieu Bastian <mathieu.bastian@gephi.org>
 Website : http://www.gephi.org

 This file is part of Gephi.

 DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 Copyright 2011 Gephi Consortium. All rights reserved.

 The contents of this file are subject to the terms of either the GNU
 General Public License Version 3 only ("GPL") or the Common
 Development and Distribution License("CDDL") (collectively, the
 "License"). You may not use this file except in compliance with the
 License. You can obtain a copy of the License at
 http://gephi.org/about/legal/license-notice/
 or /cddl-1.0.txt and /gpl-3.0.txt. See the License for the
 specific language governing permissions and limitations under the
 License.  When distributing the software, include this License Header
 Notice in each file and include the License files at
 /cddl-1.0.txt and /gpl-3.0.txt. If applicable, add the following below the
 License Header, with the fields enclosed by brackets [] replaced by
 your own identifying information:
 "Portions Copyrighted [year] [name of copyright owner]"

 If you wish your version of this file to be governed by only the CDDL
 or only the GPL Version 3, indicate your decision by adding
 "[Contributor] elects to include this software in this distribution
 under the [CDDL or GPL Version 3] license." If you do not indicate a
 single choice of license, a recipient has the option to distribute
 your version of this file under either the CDDL, the GPL Version 3 or
 to extend the choice of license to its licensees as provided above.
 However, if you add GPL Version 3 code and therefore, elected the GPL
 Version 3 license, then the option applies only if the new code is
 made subject to such option by the copyright holder.

 Contributor(s):

 Portions Copyrighted 2011 Gephi Consortium.
 */
package org.gephi.io.importer.api;

import org.gephi.graph.api.Interval;
import org.gephi.graph.api.TimeFormat;
import org.gephi.graph.api.TimeRepresentation;
import org.gephi.io.processor.spi.Processor;
import org.joda.time.DateTimeZone;

/**
 * Interface for unloading a container.
 * <p>
 * Gives access to the draft graph elements, columns attributes. Also gives
 * access to basic settings and properties about the container's content.
 * <p>
 * Unloaders are used by <code>Processor</code> to load data from the container
 * to the main data structure.
 *
 * @author Mathieu Bastian
 * @see Processor
 */
public interface ContainerUnloader {

    public Iterable<NodeDraft> getNodes();

    public int getNodeCount();

    public Iterable<EdgeDraft> getEdges();

    public int getEdgeCount();

    public boolean hasNodeColumn(String key);

    public boolean hasEdgeColumn(String key);

    /**
     * Returns the node column draft with <code>key</code> as identifier.
     *
     * @param key node column key
     * @return column draft or null if not found
     */
    public ColumnDraft getNodeColumn(String key);

    /**
     * Returns the edge column draft with <code>key</code> as identifier.
     *
     * @param key edge column key
     * @return column draft or null if not found
     */
    public ColumnDraft getEdgeColumn(String key);

    public Iterable<ColumnDraft> getNodeColumns();

    public Iterable<ColumnDraft> getEdgeColumns();

    public EdgeDirectionDefault getEdgeDefault();

    public TimeFormat getTimeFormat();

    public TimeRepresentation getTimeRepresentation();

    public DateTimeZone getTimeZone();

    public String getSource();

    public Class getEdgeTypeLabelClass();

    public Double getTimestamp();

    public Interval getInterval();

    public ElementIdType getElementIdType();

    //PARAMETERS GETTERS
    public boolean allowSelfLoop();

    public boolean allowAutoNode();

    public boolean allowParallelEdges();

    public boolean isAutoScale();
    
    public boolean isFillLabelWithId();

    public EdgeMergeStrategy getEdgesMergeStrategy();
}