org.gecko.emf.mongo

Class MongoUtils

java.lang.Object

org.gecko.emf.mongo.MongoUtils

public class MongoUtils
extends java.lang.Object

Helper class with commonly used calls

Constructor Summary

Constructors

Constructor and Description
MongoUtils()

Method Summary

Modifier and Type	Method and Description
static EStructuralFeature	getEStructuralFeatureByName(EClass eclass, java.lang.String name) Returns the EStructuralFeature from the given EClass, using the given name.
static EStructuralFeature	getEStructuralFeatureByName(EClass eclass, java.lang.String name, boolean useAnnotation) Returns the EStructuralFeature from the given EClass, using the given name.
static java.lang.Object	getID(URI uri) This function extracts the object ID from the given URI.
static java.lang.String	getIDAsString(URI uri) This function extracts the object ID from the given URI.
static java.lang.Object	getIDWithValidURI(URI uri) This function extracts the object ID from the given URI.
static java.lang.String	getNameByEStructuralFeature(EStructuralFeature feature, boolean useAnnotation) Returns the name of the given EStructuralFeature.
static boolean	isNativeType(EDataType dataType) This function determines whether or not the given EDataType can be represented natively by MongoDB.

Methods inherited from class java.lang.Object

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

Constructor Detail

MongoUtils

public MongoUtils()

Method Detail

getID

public static java.lang.Object getID(URI uri)
                              throws java.io.IOException

This function extracts the object ID from the given URI. The URI path must have exactly 3 segments and be of the form mongodb://host:[port]/database/collection/{id} where id is optional.

Parameters:

uri -

Returns:

the object ID from the given URI or null if the id was not specified

Throws:

java.io.IOException - if the URI path is not exactly three segments

getIDAsString

public static java.lang.String getIDAsString(URI uri)
                                      throws java.io.IOException

This function extracts the object ID from the given URI. The URI path must have exactly 3 segments and be of the form mongodb://host:[port]/database/collection/{id} where id is optional.

Parameters:

uri -

Returns:

the object ID from the given URI or null if the id was not specified

Throws:

java.io.IOException - if the URI path is not exactly three segments

getIDWithValidURI

public static java.lang.Object getIDWithValidURI(URI uri)

This function extracts the object ID from the given URI. The URI path must have exactly 3 segments and be of the form mongodb://host:[port]/database/collection/{id} where id is optional.

Parameters:

uri -

Returns:

the object ID from the given URI or null if the id was not specified

isNativeType

public static boolean isNativeType(EDataType dataType)

This function determines whether or not the given EDataType can be represented natively by MongoDB.

Parameters:

dataType - the EMF data type to check

Returns:

true if the data type can be represented natively by MongoDB; false otherwise

getNameByEStructuralFeature

public static java.lang.String getNameByEStructuralFeature(EStructuralFeature feature,
                                                           boolean useAnnotation)

Returns the name of the given EStructuralFeature. If the useAnnotation parameter is set to true, the ExtendedMetadata annotations will be inspected for a name detail entry and the corresponding name of the entry returned. Otherwise the feature name will returned

Parameters:

feature - the EStructuralFeature to look into

useAnnotation - set to true, if Extended MetaData annotation should used too

Returns:

the name of the feature or null

getEStructuralFeatureByName

public static EStructuralFeature getEStructuralFeatureByName(EClass eclass,
                                                             java.lang.String name,
                                                             boolean useAnnotation)

Returns the EStructuralFeature from the given EClass, using the given name. If the useAnnotation parameter is set to true, the ExtendedMetadata annotations will be inspected for a name detail entry and the corresponding feature will returned.

Parameters:

eclass - the EClass to look into

name - the feature name

useAnnotation - set to true, if Extended MetaData annotation should used too

Returns:

the EStructuralFeature or null

getEStructuralFeatureByName

public static EStructuralFeature getEStructuralFeatureByName(EClass eclass,
                                                             java.lang.String name)

Returns the EStructuralFeature from the given EClass, using the given name. This does the same like getEStructuralFeatureByName(EClass, String, boolean) using as third parameter false.

Parameters:

eclass - the EClass to look into

name - the feature name

Returns:

the EStructuralFeature or null