ptolemy.homer.kernel

Class LayoutFileOperations

java.lang.Object

ptolemy.homer.kernel.LayoutFileOperations

public final class LayoutFileOperations
extends java.lang.Object

Utility class to handle model and layout file operations.

Since:

Ptolemy II 10.0

Version:

$Id: LayoutFileOperations.java 70402 2014-10-23 00:52:20Z cxh $

Author:

Peter Foldes

Accepted Rating:

Red (pdf)

Proposed Rating:

Red (pdf)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LayoutFileOperations.SinkOrSource Categorization of an entity.

Method Summary

Modifier and Type	Method and Description
static IntMatrixToken	getLocationToken(org.netbeans.api.visual.widget.Widget widget) Get the location from a widget in the form of an IntMatrixToken.
static LayoutFileOperations.SinkOrSource	isSinkOrSource(ComponentEntity entity) Check if the entity is a sink or source.
static CompositeEntity	open(HomerMainFrame mainFrame, java.net.URL modelURL, java.net.URL layoutURL) Open a model and an existing layout on the given frame.
static CompositeEntity	openModelFile(java.net.URL url) Open a MoML file, parse it, and return the parsed model.
static void	parseModel(HomerMainFrame mainFrame) Given a frame containing a model, this method will parse the model and populate the contents defined in the frame.
static void	saveAs(HomerMainFrame mainFrame, java.io.File layoutFile) Save a layout to a MoML file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

open

public static CompositeEntity open(HomerMainFrame mainFrame,
                                   java.net.URL modelURL,
                                   java.net.URL layoutURL)
                            throws IllegalActionException,
                                   NameDuplicationException,
                                   java.lang.CloneNotSupportedException

Open a model and an existing layout on the given frame. The information from both will be merged into one model that is returned.

Parameters:

mainFrame - The frame containing the contents infrastructure and the visual representations.

modelURL - The url to the original Ptolemy II model file to use.

layoutURL - The url to the layout file associated with the Ptolemy II model.

Returns:

A model that has the merged information from both the model and the layout.

Throws:

IllegalActionException - If the model cannot be merged with the layout.

java.lang.CloneNotSupportedException - If cloning of the Ptolemy II model is not supported.

NameDuplicationException - If there is a name duplication when merging the model and the layout.

parseModel

public static void parseModel(HomerMainFrame mainFrame)
                       throws IllegalActionException,
                              NameDuplicationException

Given a frame containing a model, this method will parse the model and populate the contents defined in the frame.

Parameters:

mainFrame - The frame containing the model to be parsed and the underlying contents infrastructure.

Throws:

IllegalActionException - If the parsing fails.

NameDuplicationException - If during the parsing a name duplication is found.

openModelFile

public static CompositeEntity openModelFile(java.net.URL url)
                                     throws IllegalActionException

Open a MoML file, parse it, and return the parsed model.

Parameters:

url - The url of the model.

Returns:

The parsed model.

Throws:

IllegalActionException - If the parsing failed.

saveAs

public static void saveAs(HomerMainFrame mainFrame,
                          java.io.File layoutFile)

Save a layout to a MoML file. The layout file should contain all the information needed to create visual representations of elements and to communicate remotely.

Parameters:

mainFrame - The object containing all the information about the elements to create the layout file, such as position information.

layoutFile - The file the layout is saved to.

getLocationToken

public static IntMatrixToken getLocationToken(org.netbeans.api.visual.widget.Widget widget)

Get the location from a widget in the form of an IntMatrixToken.

Parameters:

widget - The widget from where to extract the location from.

Returns:

The IntMatrixToken representing the location of the widget.

isSinkOrSource

public static LayoutFileOperations.SinkOrSource isSinkOrSource(ComponentEntity entity)

Check if the entity is a sink or source. It checks based on the ports of connected relations.

Parameters:

entity - The Ptolemy entity to check.

Returns:

SinkOrSource enumeration indicating whether the entity is a sink, a source, both, or none.