com.highqsoft.ods

Class OdsQueryHelper

java.lang.Object

com.highqsoft.ods.OdsQueryHelper

public class OdsQueryHelper
extends java.lang.Object

Helper for ASAM ODS query definitions.

Since:

$Date: 2017/04/06 13:29:36 $

Version:

$Revision: 1.12 $

Author:

Andreas Hofmann

Constructor Summary

Constructors

Constructor and Description
OdsQueryHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static QueryStructureExt	createQueryStructure(ApplicationElement aeObj, T_LONGLONG aeId, java.lang.String[] anuNames, NameValueUnit[] nvus) Create a query structure to get attributes the instances of the given application element that match the given values.
static QueryStructureExt	createQueryStructure(ApplicationElement aeObj, T_LONGLONG aeId, java.lang.String[] anuNames, NameValueUnit[] nvus, boolean lastOne) Create a query structure to get attributes the instances of the given application element that match the given values.
static QueryStructureExt	createQueryStructure(ApplicationElement aeObj, T_LONGLONG aeId, java.lang.String[] anuNames, NameValueUnit[] nvus, boolean lastOne, java.lang.String relName, T_LONGLONG relId) Create a query structure to get attributes the instances of the given application element that match the given values.
static T_LONGLONG[]	getIds(ApplElemAccess aea, ApplicationElement ae) Return the list of the Id from all instances of the application element
static T_LONGLONG[]	getIds(ApplElemAccess applAccess, ApplicationElement aeObj, T_LONGLONG aeId, java.lang.String idAttr, NameValueUnit[] nvus) Get the ids of the instances derived from the given application element that match the given values.
static T_LONGLONG[]	getIds(ApplElemAccess aea, T_LONGLONG aid, java.lang.String aaIdName) Return the list of the Id from all instances of the application element
static T_LONGLONG[]	getIds(ElemResultSet[] res, T_LONGLONG aid, java.lang.String aaIdName) Return the list of the Id attributes of the Element Result Set.
static T_LONGLONG[]	getIds(ElemResultSetExt[] res, T_LONGLONG aid, java.lang.String aaIdName) Return the list of the Id attributes of the Element Result Set.
static T_LONGLONG[]	getIdsAscending(ApplElemAccess aea, T_LONGLONG aid, java.lang.String aaIdName) Return the list of the Id from all instances of the application element
static T_LONGLONG	getLastId(ApplElemAccess applAccess, ApplicationElement aeObj, T_LONGLONG aeId, java.lang.String idAttr, NameValueUnit[] nvus) Get the maximum of the ids of the instances derived from the given application element that match the given values.
static T_LONGLONG	getLastId(ApplElemAccess applAccess, ApplicationElement aeObj, T_LONGLONG aeId, java.lang.String idAttr, NameValueUnit[] nvus, java.lang.String relName, T_LONGLONG relId) Get the maximum of the ids of the instances derived from the given application element that match the given values.

Methods inherited from class java.lang.Object

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

Constructor Detail

OdsQueryHelper

public OdsQueryHelper()

Method Detail

getLastId

public static T_LONGLONG getLastId(ApplElemAccess applAccess,
                   ApplicationElement aeObj,
                   T_LONGLONG aeId,
                   java.lang.String idAttr,
                   NameValueUnit[] nvus)
                            throws AoException

Get the maximum of the ids of the instances derived from the given application element that match the given values. If there are no elements the method return null

Parameters:

applAccess - The application access element for query.

aeObj - The ApplicationElement.

aeId - the application element id (may be null).

idAttr - Name name of the attribute of the base type id (may be null).

nvus - the values.

Returns:

the maximum of the id values of the instances that match the conditions.

Throws:

AoException - if an ASAM ODS call fails.

getLastId

public static T_LONGLONG getLastId(ApplElemAccess applAccess,
                   ApplicationElement aeObj,
                   T_LONGLONG aeId,
                   java.lang.String idAttr,
                   NameValueUnit[] nvus,
                   java.lang.String relName,
                   T_LONGLONG relId)
                            throws AoException

Get the maximum of the ids of the instances derived from the given application element that match the given values. If there are no elements the method return null

Parameters:

applAccess - The application access element for query.

aeObj - The ApplicationElement.

aeId - the application element id (may be null).

idAttr - Name name of the attribute of the base type id (may be null).

nvus - the values.

relName - The name of the relation name

relId - the id of the related instance element.

Returns:

the maximum of the id values of the instances that match the conditions.

Throws:

AoException - if an ASAM ODS call fails.

getIds

public static T_LONGLONG[] getIds(ApplElemAccess applAccess,
                  ApplicationElement aeObj,
                  T_LONGLONG aeId,
                  java.lang.String idAttr,
                  NameValueUnit[] nvus)
                           throws AoException

Get the ids of the instances derived from the given application element that match the given values. If there are no elements the method returns an empty array.

Parameters:

applAccess - The application access element for query.

aeObj - The ApplicationElement.

aeId - the application element id (may be null).

idAttr - Name name of the attribute of the base type id (may be null).

nvus - the values.

Returns:

the array containing the ids of the instances.

Throws:

AoException - if an ASAM ODS call fails.

getIds

public static T_LONGLONG[] getIds(ApplElemAccess aea,
                  ApplicationElement ae)
                           throws AoException

Return the list of the Id from all instances of the application element

Parameters:

aea - the access to the server.

ae - the application element which Ids will be returned

Returns:

the list with Ids.

Throws:

AoException

getIds

public static T_LONGLONG[] getIds(ApplElemAccess aea,
                  T_LONGLONG aid,
                  java.lang.String aaIdName)
                           throws AoException

Return the list of the Id from all instances of the application element

Parameters:

aea - the access to the server.

aid - Id of the application element.

aaIdName - the attribute name of the Id.

Returns:

the list with Ids.

Throws:

AoException

getIdsAscending

public static T_LONGLONG[] getIdsAscending(ApplElemAccess aea,
                           T_LONGLONG aid,
                           java.lang.String aaIdName)
                                    throws AoException

Return the list of the Id from all instances of the application element

Parameters:

aea - the access to the server.

aid - Id of the application element.

aaIdName - the attribute name of the Id.

Returns:

the list with Ids.

Throws:

AoException

getIds

public static T_LONGLONG[] getIds(ElemResultSet[] res,
                  T_LONGLONG aid,
                  java.lang.String aaIdName)
                           throws AoException

Return the list of the Id attributes of the Element Result Set.

Parameters:

res - the element result set.

aid - the application element Id which Ids will be returned

aaIdName - the name of the Id attribute.

Returns:

the list with Ids.

Throws:

AoException

getIds

public static T_LONGLONG[] getIds(ElemResultSetExt[] res,
                  T_LONGLONG aid,
                  java.lang.String aaIdName)
                           throws AoException

Return the list of the Id attributes of the Element Result Set.

Parameters:

res - the element result set.

aid - the application element Id which Ids will be returned

aaIdName - the name of the Id attribute.

Returns:

the list with Ids.

Throws:

AoException

createQueryStructure

public static QueryStructureExt createQueryStructure(ApplicationElement aeObj,
                                     T_LONGLONG aeId,
                                     java.lang.String[] anuNames,
                                     NameValueUnit[] nvus)
                                              throws AoException

Create a query structure to get attributes the instances of the given application element that match the given values.

Parameters:

aeObj - The ApplicationElement.

aeId - the application element id (may be null).

anuNames - the names of the attributes to listed.

nvus - the values.

Returns:

the querystructure

Throws:

AoException - if an ASAM ODS call fails.

createQueryStructure

public static QueryStructureExt createQueryStructure(ApplicationElement aeObj,
                                     T_LONGLONG aeId,
                                     java.lang.String[] anuNames,
                                     NameValueUnit[] nvus,
                                     boolean lastOne)
                                              throws AoException

Create a query structure to get attributes the instances of the given application element that match the given values.

Parameters:

aeObj - The ApplicationElement.

aeId - the application element id (may be null).

anuNames - the names of the attributes to listed.

nvus - the values.

lastOne - request the last one (highest ID) of the existing elements (works if the is an element of the anuNames only).

Returns:

the querystructure

Throws:

AoException - if an ASAM ODS call fails.

createQueryStructure

public static QueryStructureExt createQueryStructure(ApplicationElement aeObj,
                                     T_LONGLONG aeId,
                                     java.lang.String[] anuNames,
                                     NameValueUnit[] nvus,
                                     boolean lastOne,
                                     java.lang.String relName,
                                     T_LONGLONG relId)
                                              throws AoException

Create a query structure to get attributes the instances of the given application element that match the given values.

Parameters:

aeObj - The ApplicationElement.

aeId - the application element id (may be null).

anuNames - the names of the attributes to listed.

nvus - the values.

lastOne - request the last one (highest ID) of the existing elements (works if the is an element of the anuNames only).

relname - the name of the relation attribute to be considered for the query.

relId - The related instance element id, blong to the relname.

Returns:

the querystructure

Throws:

AoException - if an ASAM ODS call fails.