ptdb.common.util

Class Utilities

java.lang.Object

ptdb.common.util.Utilities

public class Utilities
extends java.lang.Object

Provide utility functions for document parsing etc.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Ashwini Bijwe

Pt.AcceptedRating:

Red (abijwe)

Pt.ProposedRating:

Red (abijwe)

Constructor Summary

Constructors

Constructor and Description
Utilities()

Method Summary

Modifier and Type	Method and Description
static boolean	checkAttributeName(java.lang.String name) Check if the given name meet the attribute name convention.
static boolean	checkFileExists(java.lang.String filePath) Check whether the given file exists.
static boolean	checkModelName(java.lang.String name) Check if the given name meet the model name convention.
static java.lang.String	generateId(java.lang.String name) Create new Id by appending a timestamp to the given name.
static java.lang.String	getDocumentXMLString(org.w3c.dom.Document document) Convert the document node to string.
static java.lang.String	getIdFromModel(NamedObj model) Extra the PTDB model id from a given Ptolemy model.
static java.lang.String	getPropertyString(java.lang.String propertyName, java.lang.String propertyValue) Create the property node string to add to a MOML with the class as StringConstantParameter.
static java.lang.String	getValueForAttribute(org.w3c.dom.Node currentNode, java.lang.String attributeName) Get the value for the given attribute.
static java.lang.String	insertIdTagToModelBody(java.lang.String modelBody, java.lang.String modelId) Add a parameter tag called DBModelId to the given model body.
static java.util.ArrayList<XMLDBModel>	intersectResults(java.util.ArrayList<XMLDBModel> previousResults, java.util.ArrayList<XMLDBModel> currentResults) Intersect the XMLDBModels results from two list, and take the common ones and return them in a new list.
static boolean	modelReferenceExists(java.lang.String modelName, java.lang.String referenceString) Check if the model name exists in the given reference string.
static org.w3c.dom.Node	parseXML(java.lang.String xmlString) Parse the xml string that is passed to it and return the upper node of that xml.

Methods inherited from class java.lang.Object

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

Constructor Detail

Utilities

public Utilities()

Method Detail

checkModelName

public static boolean checkModelName(java.lang.String name)
                              throws IllegalNameException

Check if the given name meet the model name convention.

Parameters:

name - The name to be verified.

Returns:

true - if the name is valid.
false - if the name is invalid.

Throws:

IllegalNameException - Thrown if the verifying name is invalid.

checkAttributeName

public static boolean checkAttributeName(java.lang.String name)
                                  throws IllegalNameException

Check if the given name meet the attribute name convention.

Parameters:

name - The name to be verified.

Returns:

true - if the name is valid.
false - if the name is invalid.

Throws:

IllegalNameException - Thrown if the verifying name is invalid.

checkFileExists

public static boolean checkFileExists(java.lang.String filePath)

Check whether the given file exists.

Parameters:

filePath - Path for the file.

Returns:

True, if file exists, false otherwise.

generateId

public static java.lang.String generateId(java.lang.String name)

Create new Id by appending a timestamp to the given name.

Parameters:

name - The name that will be used to generate the id.

Returns:

An Id that is a combination of the name passed with the time stamp.

getDocumentXMLString

public static java.lang.String getDocumentXMLString(org.w3c.dom.Document document)

Convert the document node to string.

Parameters:

document - Document which needs to be converted to String.

Returns:

String for the given document.

getIdFromModel

public static java.lang.String getIdFromModel(NamedObj model)

Extra the PTDB model id from a given Ptolemy model.

Parameters:

model - The model to be extracted the id.

Returns:

The id of the model in the database. If that model hasn't been stored in the database yet, return null.

getPropertyString

public static java.lang.String getPropertyString(java.lang.String propertyName,
                                                 java.lang.String propertyValue)

Create the property node string to add to a MOML with the class as StringConstantParameter.

Parameters:

propertyName - Name for the property.

propertyValue - Value for the property.

Returns:

Property node string for the given name and value.

getValueForAttribute

public static java.lang.String getValueForAttribute(org.w3c.dom.Node currentNode,
                                                    java.lang.String attributeName)

Get the value for the given attribute.

Parameters:

currentNode - Node for which attribute value needs to be determined.

attributeName - Name of the attribute.

Returns:

Return the value for the given attribute. Return null if attribute not present for the given node.

insertIdTagToModelBody

public static java.lang.String insertIdTagToModelBody(java.lang.String modelBody,
                                                      java.lang.String modelId)

Add a parameter tag called DBModelId to the given model body.

Parameters:

modelBody - The XML model body where the Id parameter will be added.

modelId - The Id of the model that needs to be inserted.

Returns:

The resulting modelBody after inserting the Id to it.

intersectResults

public static java.util.ArrayList<XMLDBModel> intersectResults(java.util.ArrayList<XMLDBModel> previousResults,
                                                               java.util.ArrayList<XMLDBModel> currentResults)

Intersect the XMLDBModels results from two list, and take the common ones and return them in a new list.

Parameters:

previousResults - The list of the first batch of models.

currentResults - The list of the second batch of models.

Returns:

The list of common models from both lists.

modelReferenceExists

public static boolean modelReferenceExists(java.lang.String modelName,
                                           java.lang.String referenceString)

Check if the model name exists in the given reference string.

Parameters:

modelName - Model name to check.

referenceString - Reference string to check within.

Returns:

True if the model name is present within the given reference string, false otherwise.

parseXML

public static org.w3c.dom.Node parseXML(java.lang.String xmlString)
                                 throws XMLDBModelParsingException

Parse the xml string that is passed to it and return the upper node of that xml.

Parameters:

xmlString - The xml string that needs to be parsed

Returns:

The upper node for the xml string after parsing it.

Throws:

XMLDBModelParsingException - Thrown if a parser exceptions was thrown