ptserver.util

Class ServerUtility

java.lang.Object

ptserver.util.ServerUtility

public class ServerUtility
extends java.lang.Object

Class containing helper methods used by the ptserver and/or Homer.

Since:

Ptolemy II 10.0

Version:

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

Author:

Anar Huseynov

Accepted Rating:

Red (ahuseyno)

Proposed Rating:

Red (ahuseyno)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROXY_SINK_ATTRIBUTE Attribute value indicating that the actor is a sink.
static java.lang.String	PROXY_SOURCE_ATTRIBUTE Attribute value indicating that the actor is a source.
static java.lang.String	REMOTE_ATTRIBUTE Attribute value indicating that the parent attribute is a remote attribute - its value needs to synchronized between client and server models.
static java.lang.String	REMOTE_OBJECT_TAG Attribute name indicating that the named object needs to be handled by the ProxyModelBuilder.

Constructor Summary

Constructors

Constructor and Description
ServerUtility()

Method Summary

Modifier and Type	Method and Description
static MoMLParser	createMoMLParser() Create and initialize a new MoMLParser.
static java.util.List<Attribute>	deepAttributeList(NamedObj container) Return the deep attribute list of the container in a depth first order.
static void	findRemoteAttributes(java.util.List<Attribute> attributeList, java.util.HashMap<java.lang.String,Settable> remoteAttributeMap) Find all remote attributes of the model and add them to the remoteAttributeMap.
static boolean	isRemoteAttribute(Attribute attribute) Return true if the attribute is marked as remote attribute, false otherwise.
static boolean	isTargetProxySink(Attribute targetEntityAttribute) Return true if the attribute is marked as remote sink, false otherwise.
static boolean	isTargetProxySource(Attribute targetEntityAttribute) Return true if the attribute is marked as remote source, false otherwise.
static CompositeEntity	mergeModelWithLayout(CompositeEntity model, CompositeEntity layout, java.util.HashSet<java.lang.Class<? extends Attribute>> classesToMerge, java.util.HashSet<java.lang.String> namedObjectsToMerge) Merge the model with layout.
static CompositeEntity	mergeModelWithLayout(java.lang.String modelURL, java.lang.String layoutURL, java.util.HashSet<java.lang.Class<? extends Attribute>> classesToMerge, java.util.HashSet<java.lang.String> namedObjectsToMerge) Merge the model with layout.
static CompositeEntity	mergeModelWithLayout(java.net.URL modelURL, java.net.URL layoutURL, java.util.HashSet<java.lang.Class<? extends Attribute>> classesToMerge, java.util.HashSet<java.lang.String> namedObjectsToMerge) Merge the model with layout.
static CompositeEntity	openModelFile(java.net.URL url) Open a MoML file, parse it, and the parsed model.
static java.lang.String	stripFullName(java.lang.String fullName) Strips the first part of a compound element name, including the "." at the beginning.
LayoutValidationErrors	validateModelAndLayout(java.lang.String modelURL, java.lang.String layoutURL) Validate the model and layout and return list of errors that might prevent merging.

Methods inherited from class java.lang.Object

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

Field Detail

REMOTE_ATTRIBUTE

public static final java.lang.String REMOTE_ATTRIBUTE

Attribute value indicating that the parent attribute is a remote attribute - its value needs to synchronized between client and server models.

See Also:

Constant Field Values

REMOTE_OBJECT_TAG

public static final java.lang.String REMOTE_OBJECT_TAG

Attribute name indicating that the named object needs to be handled by the ProxyModelBuilder.

See Also:

Constant Field Values

PROXY_SOURCE_ATTRIBUTE

public static final java.lang.String PROXY_SOURCE_ATTRIBUTE

Attribute value indicating that the actor is a source.

See Also:

Constant Field Values

PROXY_SINK_ATTRIBUTE

public static final java.lang.String PROXY_SINK_ATTRIBUTE

Attribute value indicating that the actor is a sink.

See Also:

Constant Field Values

Constructor Detail

ServerUtility

public ServerUtility()

Method Detail

createMoMLParser

public static MoMLParser createMoMLParser()

Create and initialize a new MoMLParser. The parser would have BackwardCompatibility and RemoveGraphicalClasses filters. The RemoteGraphicalClasses would filter out only classes that are known not to be portable to be portable to Android.

Returns:

new MoMLParser with BackwardCompatibility and RemoveGraphicalClasses filters.

deepAttributeList

public static java.util.List<Attribute> deepAttributeList(NamedObj container)

Return the deep attribute list of the container in a depth first order.

Parameters:

container - the container to process.

Returns:

the deep attribute list of the container.

findRemoteAttributes

public static void findRemoteAttributes(java.util.List<Attribute> attributeList,
                                        java.util.HashMap<java.lang.String,Settable> remoteAttributeMap)

Find all remote attributes of the model and add them to the remoteAttributeMap.

Parameters:

attributeList - the attribute list to search

remoteAttributeMap - the map where the attributes need to be added.

isRemoteAttribute

public static boolean isRemoteAttribute(Attribute attribute)

Return true if the attribute is marked as remote attribute, false otherwise.

Parameters:

attribute - the child attribute of the attribute to be checked.

Returns:

true if the attribute is marked as remote attribute, false otherwise.

isTargetProxySink

public static boolean isTargetProxySink(Attribute targetEntityAttribute)

Return true if the attribute is marked as remote sink, false otherwise.

Parameters:

targetEntityAttribute - the child attribute the source actor to be checked.

Returns:

true if the attribute is marked as remote attribute, false otherwise.

isTargetProxySource

public static boolean isTargetProxySource(Attribute targetEntityAttribute)

Return true if the attribute is marked as remote source, false otherwise.

Parameters:

targetEntityAttribute - the child attribute of the source actor to be checked.

Returns:

true if the attribute is marked as remote attribute, false otherwise.

mergeModelWithLayout

public static CompositeEntity mergeModelWithLayout(CompositeEntity model,
                                                   CompositeEntity layout,
                                                   java.util.HashSet<java.lang.Class<? extends Attribute>> classesToMerge,
                                                   java.util.HashSet<java.lang.String> namedObjectsToMerge)
                                            throws IllegalActionException,
                                                   NameDuplicationException,
                                                   java.lang.CloneNotSupportedException

Merge the model with layout.

Parameters:

model - The model to merge.

layout - The layout to merge.

classesToMerge - The classes that need to be merged.

namedObjectsToMerge - The named objects that need to be merged.

Returns:

the merged model.

Throws:

IllegalActionException - if there is a problem merging the model.

NameDuplicationException - if there is a problem merging the model.

java.lang.CloneNotSupportedException - if there is a problem merging the model.

mergeModelWithLayout

public static CompositeEntity mergeModelWithLayout(java.net.URL modelURL,
                                                   java.net.URL layoutURL,
                                                   java.util.HashSet<java.lang.Class<? extends Attribute>> classesToMerge,
                                                   java.util.HashSet<java.lang.String> namedObjectsToMerge)
                                            throws IllegalActionException,
                                                   NameDuplicationException,
                                                   java.lang.CloneNotSupportedException

Merge the model with layout.

Parameters:

modelURL - The URL to the model.

layoutURL - The URL to the layout.

classesToMerge - The classes that need to be merged.

namedObjectsToMerge - The named objects that need to be merged.

Returns:

the merged model.

Throws:

IllegalActionException - if there is a problem merging the model.

NameDuplicationException - if there is a problem merging the model.

java.lang.CloneNotSupportedException - if there is a problem merging the model.

mergeModelWithLayout

public static CompositeEntity mergeModelWithLayout(java.lang.String modelURL,
                                                   java.lang.String layoutURL,
                                                   java.util.HashSet<java.lang.Class<? extends Attribute>> classesToMerge,
                                                   java.util.HashSet<java.lang.String> namedObjectsToMerge)
                                            throws java.net.MalformedURLException,
                                                   IllegalActionException,
                                                   NameDuplicationException,
                                                   java.lang.CloneNotSupportedException

Merge the model with layout.

Parameters:

modelURL - The URL to the model.

layoutURL - The URL to the layout.

classesToMerge - The classes that need to be merged.

namedObjectsToMerge - The named objects that need to be merged.

Returns:

the merged model.

Throws:

java.net.MalformedURLException - if there is a problem merging the model.

IllegalActionException - if there is a problem merging the model.

NameDuplicationException - if there is a problem merging the model.

java.lang.CloneNotSupportedException - if there is a problem merging the model.

openModelFile

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

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

Parameters:

url - The url of the model.

Returns:

The parsed model.

Throws:

IllegalActionException - If the parsing failed.

stripFullName

public static java.lang.String stripFullName(java.lang.String fullName)

Strips the first part of a compound element name, including the "." at the beginning.

Parameters:

fullName - The compound name of an element.

Returns:

The stripped name of the element, where the first part of the compound name is removed, including the "." at the beginning.

validateModelAndLayout

public LayoutValidationErrors validateModelAndLayout(java.lang.String modelURL,
                                                     java.lang.String layoutURL)

Validate the model and layout and return list of errors that might prevent merging.

Parameters:

modelURL - The URL of the model.

layoutURL - The URL of the layout.

Returns:

the list of the layout validation errors.