de.iip_ecosphere.platform.support.iip_aas

Class ClassUtility

java.lang.Object

de.iip_ecosphere.platform.support.iip_aas.ClassUtility

public class ClassUtility
extends Object

Utility functions for representing types in AAS. A Java type is turned into

• Submodel: types
  • Submodel elements collection: Java type name, inner classes as "."
    • Property: ATTRIBUTE_PREFIX + attribute name, value = type (for primitives or String)
    • Submodel elements collection: ATTRIBUTE_PREFIX + attribute name
      • Property/ReferenceElement: NAME_ARRAY_PROPERTY_TYPE (property for primitives or String, reference element for reference types)
      • Property NAME_ARRAY_PROPERTY_DIMENSIONS numeric number of nested array dimensions
    • ReferenceElement: ATTRIBUTE_PREFIX + attribute name, value = ref-to collection (for reference types)

Type usages, e.g., for input/output types are translated to

• Property: attribute1 name, value = type (for primitives, arrays and String)
• ReferenceElement: attribute1 name, value = ref-to collection (for reference types)

Attributes marked by Skip will not be listed. So far, arrays over reference types are represented as strings rather than references to the component type. The implemented format is initial and will change over time (array of ref type unclear, generics).

Author:

Holger Eichelberger, SSE

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_PREFIX
static String	NAME_ARRAY_PROPERTY_DIMENSIONS
static String	NAME_ARRAY_PROPERTY_TYPE
private static Map<Class<?>,String>	NAME_MAPPING
static String	NAME_TYPE_SUBMODEL

Constructor Summary

Constructors

Constructor and Description
ClassUtility()

Method Summary

Modifier and Type	Method and Description
static de.iip_ecosphere.platform.support.aas.Reference	addType(de.iip_ecosphere.platform.support.aas.Aas.AasBuilder aasBuilder, Class<?> type) Adds a type to an AAS as sub-model.
private static de.iip_ecosphere.platform.support.aas.Reference	addType(de.iip_ecosphere.platform.support.aas.SubmodelElementCollection.SubmodelElementCollectionBuilder builder, Class<?> type) Adds a type to a sub-model.
static de.iip_ecosphere.platform.support.aas.SubmodelElement	addTypeSubModelElement(de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder subModelBuilder, String idShort, Class<?> type) Adds a type-representing sub-model element.
static String	getId(String prefix, Object object) Turns the object into a unique id with given (optional) prefix.
static String	getName(Class<?> type) Returns the name of the associated model element.
private static void	registerBySimpleName(Class<?> type) Registers a type by its simple name.
private static void	registerBySimpleName(Class<?> type, Class<?> nameType) Registers a type by the simple name of nameType, e.g., to map wrappers to their primitive types.

Methods inherited from class java.lang.Object

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

Field Detail

NAME_TYPE_SUBMODEL

public static final String NAME_TYPE_SUBMODEL

See Also:

Constant Field Values

ATTRIBUTE_PREFIX

public static final String ATTRIBUTE_PREFIX

See Also:

Constant Field Values

NAME_ARRAY_PROPERTY_TYPE

public static final String NAME_ARRAY_PROPERTY_TYPE

See Also:

Constant Field Values

NAME_ARRAY_PROPERTY_DIMENSIONS

public static final String NAME_ARRAY_PROPERTY_DIMENSIONS

See Also:

Constant Field Values

NAME_MAPPING

private static final Map<Class<?>,String> NAME_MAPPING

Constructor Detail

ClassUtility

public ClassUtility()

Method Detail

registerBySimpleName

private static void registerBySimpleName(Class<?> type)

Registers a type by its simple name.

Parameters:

type - the type

registerBySimpleName

private static void registerBySimpleName(Class<?> type,
                                         Class<?> nameType)

Registers a type by the simple name of nameType, e.g., to map wrappers to their primitive types.

Parameters:

type - the type

nameType - the type providing the name

addType

public static de.iip_ecosphere.platform.support.aas.Reference addType(de.iip_ecosphere.platform.support.aas.Aas.AasBuilder aasBuilder,
                                                                      Class<?> type)

Adds a type to an AAS as sub-model. If the type already exists in the AAS/submodel, no new element will be created just a reference to it will be returned. [static data]

Parameters:

aasBuilder - the AAS builder

type - the type to add

Returns:

the reference to the sub-model (null if nothing was created)

addType

private static de.iip_ecosphere.platform.support.aas.Reference addType(de.iip_ecosphere.platform.support.aas.SubmodelElementCollection.SubmodelElementCollectionBuilder builder,
                                                                       Class<?> type)

Adds a type to a sub-model. [static data]

Parameters:

builder - the target sub-model

type - the type to add

Returns:

the reference to the type (null if nothing was created)

addTypeSubModelElement

public static de.iip_ecosphere.platform.support.aas.SubmodelElement addTypeSubModelElement(de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder subModelBuilder,
                                                                                           String idShort,
                                                                                           Class<?> type)

Adds a type-representing sub-model element. [static data]

Parameters:

subModelBuilder - the target sub-model

idShort - the name of the element

type - the type to represent in the element

Returns:

the created sub-model element

getName

public static String getName(Class<?> type)

Returns the name of the associated model element.

Parameters:

type - the type

Returns:

the name

getId

public static String getId(String prefix,
                           Object object)

Turns the object into a unique id with given (optional) prefix.

Parameters:

prefix - an optional prefix, use an empty string for none; shall end with a separator, e.g., "_"

object - the object to be turned into a unique id

Returns:

the combined id