Interface GraphCutData

codecut-gui/src/main/java/graphcut/GraphCutData.java:43–97

Allows us to retrieve and work on the graph. Makes caching data simple

 * Allows us to retrieve and work on the graph. Makes caching data simple
 */
public interface GraphCutData {
	
	/**
	 * The namespace of this data
	 * @return the namespace
	 */
	Namespace getNamespace();
	
	/**
	 * The graph of this data
	 * @return the graph
	 */
	GraphCutGraph getGraph();
	
	/**
	 * Returns the cache of edges. Not in the graph but used to track existing edges that are not yet in the graph.
	 * @return
	 */
	NamespaceEdgeCache getNamespaceEdgeCache();
	
	/**
	 * True if this data has a valid namespace
	 * @return true if this data has a valid namespace
	 */
	boolean hasResults();
	
	/**
	 * False if the graph in this data has not yet been loaded
	 */
	boolean isInitialized();
	
	/**
	 * Dispose the contents of this data
	 */
	void dispose();
	
	/**
	 * Returns the view's graph perspective. this is used by the view to restore itself.
	 * @return the view's graph perspective
	 */
	GraphPerspectiveInfo<GraphCutVertex, GraphCutEdge> getGraphPerspective();
	
	/**
	 * Set the view information for this graph data
	 * @param info the perspective to set
	 */
	void setGraphPerspective(GraphPerspectiveInfo<GraphCutVertex, GraphCutEdge> info);
	
	/**
	 * Returns true if this data's namespace is equal to the given one
	 * @param ns the namespace to test
	 * @return true if this data's namespace is equal to the given one
	 */
	boolean isNamespace(Namespace ns);
}