Module nl.tno.omt

Package nl.tno.omt.helpers

Class OmtFunctions

java.lang.Object

nl.tno.omt.helpers.OmtFunctions

public class OmtFunctions
extends Object

Author:

bergtwvd

Constructor Summary

Constructors

Constructor	Description
OmtFunctions()

Method Summary

Modifier and Type	Method	Description
static int[]	geCardinality(ArrayDataTypesType.ArrayData dt)	Parse the cardinality of an array type.
static ArrayDataTypesType.ArrayData	getArrayDataByName(ObjectModelType[] modules, String datatypeName)
static ArrayDataTypesType.ArrayData	getArrayDataByName(ObjectModelType module, String datatypeName)
static ObjectModelType	getArrayDataModule(ObjectModelType[] modules, String datatypeName)
static Set<String>	getArrayDataTypesWithEncoding(ObjectModelType[] modules, Set<String> encodings)	Gets all array datatype with a given encoding
static BasicDataRepresentationsType.BasicData	getBasicDataByName(ObjectModelType[] modules, String representationName)
static BasicDataRepresentationsType.BasicData	getBasicDataByName(ObjectModelType module, String representationName)
static EnumeratedDataTypesType.EnumeratedData	getEnumeratedDataByName(ObjectModelType[] modules, String datatypeName)
static EnumeratedDataTypesType.EnumeratedData	getEnumeratedDataByName(ObjectModelType module, String datatypeName)
static ObjectModelType	getEnumeratedDataModule(ObjectModelType[] modules, String datatypeName)
static FixedRecordDataTypesType.FixedRecordData	getFixedRecordDataByName(ObjectModelType[] modules, String datatypeName)
static FixedRecordDataTypesType.FixedRecordData	getFixedRecordDataByName(ObjectModelType module, String datatypeName)
static ObjectModelType	getFixedRecordDataModule(ObjectModelType[] modules, String datatypeName)
static InteractionClass	getInteractionClass(ObjectModelType[] modules, String fqName)
static InteractionClass	getInteractionClass(ObjectModelType[] modules, String fqName, boolean nullOnScaffolding)
static InteractionClass	getInteractionClass(ObjectModelType module, String fqName)
static InteractionClass	getInteractionClass(ObjectModelType module, String fqName, boolean nullOnScaffolding)	Looks up the InteractionClass for the given FQ OMT name.
static ObjectModelType	getInteractionClassModule(ObjectModelType[] modules, String fqName)
static ObjectModelType	getInteractionClassModule(ObjectModelType[] modules, String fqName, boolean nullOnScaffolding)
static Set<Parameter>	getInteractionClassParameters(ObjectModelType[] modules, String fqName)
static ObjectClass	getObjectClass(ObjectModelType[] modules, String fqName)
static ObjectClass	getObjectClass(ObjectModelType[] modules, String fqName, boolean nullOnScaffolding)
static ObjectClass	getObjectClass(ObjectModelType module, String fqName)
static ObjectClass	getObjectClass(ObjectModelType module, String fqName, boolean nullOnScaffolding)	Looks up the ObjectClass for the given FQ OMT name.
static Set<Attribute>	getObjectClassAttributes(ObjectModelType[] modules, String fqName)
static ObjectModelType	getObjectClassModule(ObjectModelType[] modules, String fqName)
static ObjectModelType	getObjectClassModule(ObjectModelType[] modules, String fqName, boolean nullOnScaffolding)
static SimpleDataTypesType.SimpleData	getSimpleDataByName(ObjectModelType[] modules, String datatypeName)
static SimpleDataTypesType.SimpleData	getSimpleDataByName(ObjectModelType module, String datatypeName)
static ObjectModelType	getSimpleDataModule(ObjectModelType[] modules, String datatypeName)
static TransportationsType.Transportation	getTransportationByName(ObjectModelType module, String value)
static VariantRecordDataTypesType.VariantRecordData	getVariantRecordDataByName(ObjectModelType[] modules, String datatypeName)
static VariantRecordDataTypesType.VariantRecordData	getVariantRecordDataByName(ObjectModelType module, String datatypeName)
static ObjectModelType	getVariantRecordDataModule(ObjectModelType[] modules, String datatypeName)
static boolean	isScaffoldingClass(InteractionClass ic)
static boolean	isScaffoldingClass(ObjectClass oc)
static ObjectModelType	readOmt(InputStream input)
static ObjectModelType	readOmt(Reader input)
static ObjectModelType	readOmt(URL module)
static File	writeOmt(ObjectModelType omt, File output)
static File	writeOmt(ObjectModelType omt, File output, boolean formatted)
static OutputStream	writeOmt(ObjectModelType omt, OutputStream output)
static OutputStream	writeOmt(ObjectModelType omt, OutputStream output, boolean formatted)
static Writer	writeOmt(ObjectModelType omt, Writer output)
static Writer	writeOmt(ObjectModelType omt, Writer output, boolean formatted)

Methods inherited from class java.lang.Object

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

Constructor Details

OmtFunctions

public OmtFunctions()

Method Details

readOmt

public static ObjectModelType readOmt(URL module)
                               throws IOException

Throws:

IOException

readOmt

public static ObjectModelType readOmt(InputStream input)
                               throws IOException

Throws:

IOException

readOmt

public static ObjectModelType readOmt(Reader input)
                               throws IOException

Throws:

IOException

writeOmt

public static Writer writeOmt(ObjectModelType omt,
 Writer output,
 boolean formatted)
                       throws IOException

Throws:

IOException

writeOmt

public static Writer writeOmt(ObjectModelType omt,
 Writer output)
                       throws IOException

Throws:

IOException

writeOmt

public static File writeOmt(ObjectModelType omt,
 File output,
 boolean formatted)
                     throws IOException

Throws:

IOException

writeOmt

public static File writeOmt(ObjectModelType omt,
 File output)
                     throws IOException

Throws:

IOException

writeOmt

public static OutputStream writeOmt(ObjectModelType omt,
 OutputStream output,
 boolean formatted)
                             throws IOException

Throws:

IOException

writeOmt

public static OutputStream writeOmt(ObjectModelType omt,
 OutputStream output)
                             throws IOException

Throws:

IOException

isScaffoldingClass

public static boolean isScaffoldingClass(ObjectClass oc)

isScaffoldingClass

public static boolean isScaffoldingClass(InteractionClass ic)

getObjectClassModule

public static ObjectModelType getObjectClassModule(ObjectModelType[] modules,
 String fqName)

getObjectClassModule

public static ObjectModelType getObjectClassModule(ObjectModelType[] modules,
 String fqName,
 boolean nullOnScaffolding)

getObjectClass

public static ObjectClass getObjectClass(ObjectModelType[] modules,
 String fqName)

getObjectClass

public static ObjectClass getObjectClass(ObjectModelType[] modules,
 String fqName,
 boolean nullOnScaffolding)

getObjectClass

public static ObjectClass getObjectClass(ObjectModelType module,
 String fqName)

getObjectClass

public static ObjectClass getObjectClass(ObjectModelType module,
 String fqName,
 boolean nullOnScaffolding)

Looks up the ObjectClass for the given FQ OMT name. The returned value is an ObjectClass or null if none found. The returned ObjectClass may be a non-null scaffolding class, depending in the setting of nullOnScaffolding. If nullOnScaffolding is true then a null value is returned if the found ObjectClass is a scaffolding class, otherwise the found ObjectClass is returned.

Parameters:

module - : module to search

fqName - : FQ OMT name

nullOnScaffolding - : setting for scaffolding classes

Returns:

the ObjectClass or null

getObjectClassAttributes

public static Set<Attribute> getObjectClassAttributes(ObjectModelType[] modules,
 String fqName)

getInteractionClassModule

public static ObjectModelType getInteractionClassModule(ObjectModelType[] modules,
 String fqName)

getInteractionClassModule

public static ObjectModelType getInteractionClassModule(ObjectModelType[] modules,
 String fqName,
 boolean nullOnScaffolding)

getInteractionClass

public static InteractionClass getInteractionClass(ObjectModelType[] modules,
 String fqName)

getInteractionClass

public static InteractionClass getInteractionClass(ObjectModelType[] modules,
 String fqName,
 boolean nullOnScaffolding)

getInteractionClass

public static InteractionClass getInteractionClass(ObjectModelType module,
 String fqName)

getInteractionClass

public static InteractionClass getInteractionClass(ObjectModelType module,
 String fqName,
 boolean nullOnScaffolding)

Looks up the InteractionClass for the given FQ OMT name. The returned value is an InteractionClass or null if none found. The returned InteractionClass may be a non-null scaffolding class, depending in the setting of nullOnScaffolding. If nullOnScaffolding is true then a null value is returned if the found InteractionClass is a scaffolding class, otherwise the found InteractionClass is returned.

Parameters:

module - : module to search

fqName - : FQ OMT name

nullOnScaffolding - : setting for scaffolding classes

Returns:

the ObjectClass or null

getInteractionClassParameters

public static Set<Parameter> getInteractionClassParameters(ObjectModelType[] modules,
 String fqName)

getBasicDataByName

public static BasicDataRepresentationsType.BasicData getBasicDataByName(ObjectModelType[] modules,
 String representationName)

getBasicDataByName

public static BasicDataRepresentationsType.BasicData getBasicDataByName(ObjectModelType module,
 String representationName)

getSimpleDataModule

public static ObjectModelType getSimpleDataModule(ObjectModelType[] modules,
 String datatypeName)

getSimpleDataByName

public static SimpleDataTypesType.SimpleData getSimpleDataByName(ObjectModelType[] modules,
 String datatypeName)

getSimpleDataByName

public static SimpleDataTypesType.SimpleData getSimpleDataByName(ObjectModelType module,
 String datatypeName)

getFixedRecordDataModule

public static ObjectModelType getFixedRecordDataModule(ObjectModelType[] modules,
 String datatypeName)

getFixedRecordDataByName

public static FixedRecordDataTypesType.FixedRecordData getFixedRecordDataByName(ObjectModelType[] modules,
 String datatypeName)

getFixedRecordDataByName

public static FixedRecordDataTypesType.FixedRecordData getFixedRecordDataByName(ObjectModelType module,
 String datatypeName)

getVariantRecordDataModule

public static ObjectModelType getVariantRecordDataModule(ObjectModelType[] modules,
 String datatypeName)

getVariantRecordDataByName

public static VariantRecordDataTypesType.VariantRecordData getVariantRecordDataByName(ObjectModelType[] modules,
 String datatypeName)

getVariantRecordDataByName

public static VariantRecordDataTypesType.VariantRecordData getVariantRecordDataByName(ObjectModelType module,
 String datatypeName)

getEnumeratedDataModule

public static ObjectModelType getEnumeratedDataModule(ObjectModelType[] modules,
 String datatypeName)

getEnumeratedDataByName

public static EnumeratedDataTypesType.EnumeratedData getEnumeratedDataByName(ObjectModelType[] modules,
 String datatypeName)

getEnumeratedDataByName

public static EnumeratedDataTypesType.EnumeratedData getEnumeratedDataByName(ObjectModelType module,
 String datatypeName)

getArrayDataModule

public static ObjectModelType getArrayDataModule(ObjectModelType[] modules,
 String datatypeName)

getArrayDataByName

public static ArrayDataTypesType.ArrayData getArrayDataByName(ObjectModelType[] modules,
 String datatypeName)

getArrayDataByName

public static ArrayDataTypesType.ArrayData getArrayDataByName(ObjectModelType module,
 String datatypeName)

getTransportationByName

public static TransportationsType.Transportation getTransportationByName(ObjectModelType module,
 String value)

geCardinality

public static int[] geCardinality(ArrayDataTypesType.ArrayData dt)

Parse the cardinality of an array type. Syntax is: '[' '..' ']' | | 'Dynamic'

Parameters:

dt - Array datatype

Returns:

cardinality (>= 0) or null on error

getArrayDataTypesWithEncoding

public static Set<String> getArrayDataTypesWithEncoding(ObjectModelType[] modules,
 Set<String> encodings)

Gets all array datatype with a given encoding

Parameters:

modules - : modules to be searched

encodings - : set of encodings to look for

Returns: