com.highqsoft.odsx

Class OdsxSelectHelper

java.lang.Object

com.highqsoft.fwk.Fwk

com.highqsoft.odsx.OdsxSelectHelper

All Implemented Interfaces:

FwkInterface, java.io.Serializable

public class OdsxSelectHelper
extends Fwk

The OdsxSelectHelper.

Since:

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

Version:

$Revision: 1.22 $

Author:

andy

See Also:

, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OdsxSelectHelper.NameId This class is used to return a name id value pair.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	version

Constructor Summary

Constructors

Constructor and Description
OdsxSelectHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static OdsxSelectHelper.NameId[]	getChildren(InstanceElement ieObj, ApplicationElement relAe, java.lang.String pattern) Get the children instances.
static OdsxSelectHelper.NameId[]	getChildren(T_LONGLONG ieId, ApplicationElement aeObj, ApplicationElement relAe, java.lang.String pattern) Get the children instances.
static OdsxSelectHelper.NameId[]	getChildren(T_LONGLONG iid, ApplicationElement aeObj, ApplicationElement relAe, java.lang.String pattern, boolean includeVersion) Get the children of an instance.
static OdsxSelectHelper.NameId[]	getInstanceIds(ApplicationElement aeObj, java.lang.String pattern) Get the instance ids belong to an application element.
static OdsxSelectHelper.NameId[]	getInstanceIds(ApplicationElement aeObj, java.lang.String pattern, boolean includeVersion) Get the instance ids belong to an application element.
static OdsxSelectHelper.NameId[]	getNameIdFromElemResultSet(ElemResultSet elemRes, boolean includeVersion) Get from the ResultSet of the getInstance method the name(version) and the Id combination.
static OdsxSelectHelper.NameId[]	getNameIdFromResultSetExt(ResultSetExt res, java.lang.String versionName) Get from the ResultSetExt of the getInstancesExt method the name(version) and the Id combination.
static OdsxSelectHelper.NameId[]	getRelated(InstanceElement ieObj, ApplicationRelation rel, java.lang.String pattern) Get the related instances.
static OdsxSelectHelper.NameId[]	getRelated(T_LONGLONG ieId, ApplicationElement aeObj, ApplicationRelation rel, java.lang.String pattern) Get the related instances.
static OdsxSelectHelper.NameId[]	getRelated(T_LONGLONG iid, ApplicationElement aeObj, ApplicationRelation rel, java.lang.String pattern, boolean includeVersion) Get the related of an instance.
static OdsxSelectHelper.NameId[]	getRelatedExt(T_LONGLONG iid, ApplicationElement aeObj, ApplicationRelation rel, java.lang.String pattern, boolean includeVersion) Get the related elements of an instance.
java.lang.String	getVersion() Return the version string of the FWK component.
static void	main(java.lang.String[] args) Main module of this application.

Methods inherited from class com.highqsoft.fwk.Fwk

getNiceVersion, release

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

Constructor Detail

OdsxSelectHelper

public OdsxSelectHelper()

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from interface: FwkInterface

Return the version string of the FWK component.

Specified by:

getVersion in interface FwkInterface

Overrides:

getVersion in class Fwk

getNameIdFromElemResultSet

public static OdsxSelectHelper.NameId[] getNameIdFromElemResultSet(ElemResultSet elemRes,
                                                   boolean includeVersion)

Get from the ResultSet of the getInstance method the name(version) and the Id combination.

Parameters:

elemRes - The element from the elemResultSet, the first attribute is the name, the second attribute is the Id, the third attribute is the version if required.

includeVersion - The version is part of the result set.

Returns:

The list with name Id combinations.

getNameIdFromResultSetExt

public static OdsxSelectHelper.NameId[] getNameIdFromResultSetExt(ResultSetExt res,
                                                  java.lang.String versionName)

Get from the ResultSetExt of the getInstancesExt method the name(version) and the Id combination.

Parameters:

elemRes - The element from the elemResultSet, the first attribute is the name, the second attribute is the Id, the third attribute is the version if required.

versionName - The version is part of the result set this is the name of the attribute else null.

Returns:

The list with name Id combinations.

getInstanceIds

public static OdsxSelectHelper.NameId[] getInstanceIds(ApplicationElement aeObj,
                                       java.lang.String pattern)
                                                throws AoException

Get the instance ids belong to an application element.

Parameters:

aeObj - the application element.

pattern - the naming pattern of the instances.

Returns:

an array containing the instance element ids.

Throws:

AoException

getInstanceIds

public static OdsxSelectHelper.NameId[] getInstanceIds(ApplicationElement aeObj,
                                       java.lang.String pattern,
                                       boolean includeVersion)
                                                throws AoException

Get the instance ids belong to an application element.

Parameters:

aeObj - the application element.

pattern - the naming pattern of the instances.

includeVersion - if true the versioh will be selected additionally.

Returns:

an array containing the instance element ids.

Throws:

AoException

getChildren

public static OdsxSelectHelper.NameId[] getChildren(T_LONGLONG ieId,
                                    ApplicationElement aeObj,
                                    ApplicationElement relAe,
                                    java.lang.String pattern)
                                             throws AoException

Get the children instances.

Parameters:

ieId - the instance element id.

aeObj - the application element of the instance element.

relAe - The related application element.

pattern - the naming pattern of the instances.

Returns:

an array containing the instance element ids.

Throws:

AoException

getChildren

public static OdsxSelectHelper.NameId[] getChildren(InstanceElement ieObj,
                                    ApplicationElement relAe,
                                    java.lang.String pattern)
                                             throws AoException

Get the children instances.

Parameters:

ieObj - the instance element.

relAe - The related application element.

pattern - the naming pattern of the instances.

Returns:

an array containing the instance element ids.

Throws:

AoException

getChildren

public static OdsxSelectHelper.NameId[] getChildren(T_LONGLONG iid,
                                    ApplicationElement aeObj,
                                    ApplicationElement relAe,
                                    java.lang.String pattern,
                                    boolean includeVersion)
                                             throws AoException

Get the children of an instance.

Parameters:

iid - the id of the instance element.

aeObj - the application element of the instance element.

relAe - The related application element.

pattern - the naming pattern of the instances.

includeVersion - if true the version will be selected additionally.

Returns:

an array containing the instance element ids.

Throws:

AoException

getRelated

public static OdsxSelectHelper.NameId[] getRelated(T_LONGLONG ieId,
                                   ApplicationElement aeObj,
                                   ApplicationRelation rel,
                                   java.lang.String pattern)
                                            throws AoException

Get the related instances.

Parameters:

ieId - the instance element id.

aeObj - the application element of the instance element.

rel - The application relation.

pattern - the naming pattern of the instances.

Returns:

an array containing the instance element ids.

Throws:

AoException

getRelated

public static OdsxSelectHelper.NameId[] getRelated(InstanceElement ieObj,
                                   ApplicationRelation rel,
                                   java.lang.String pattern)
                                            throws AoException

Get the related instances.

Parameters:

ieObj - the instance element.

rel - The application relation.

pattern - the naming pattern of the instances.

Returns:

an array containing the instance element ids.

Throws:

AoException

getRelatedExt

public static OdsxSelectHelper.NameId[] getRelatedExt(T_LONGLONG iid,
                                      ApplicationElement aeObj,
                                      ApplicationRelation rel,
                                      java.lang.String pattern,
                                      boolean includeVersion)
                                               throws AoException

Get the related elements of an instance.

Parameters:

iid - the id of the instance element.

aeObj - the application element of the instance element.

rel - The application relation.

pattern - the naming pattern of the instances.

includeVersion - if true the versioh will be selected additionally.

Returns:

an array containing the instance element ids.

Throws:

AoException

getRelated

public static OdsxSelectHelper.NameId[] getRelated(T_LONGLONG iid,
                                   ApplicationElement aeObj,
                                   ApplicationRelation rel,
                                   java.lang.String pattern,
                                   boolean includeVersion)
                                            throws AoException

Get the related of an instance.

Parameters:

iid - the id of the instance element.

aeObj - the application element of the instance element.

rel - The application relationt.

pattern - the naming pattern of the instances.

includeVersion - if true the versioh will be selected additionally.

Returns:

an array containing the instance element ids.

Throws:

AoException

main

public static void main(java.lang.String[] args)

Main module of this application. Normally this application is started via FwkFrame, FwkApplet or FwkApplication. In case somebody wants to run this application directly, this main method is provided. All it does is passing the responsibility directly to FwkFrame.