com.highqsoft.xsd

Interface AsamOdsFactoryIF

All Known Implementing Classes:

AsamOdsFactory, AsamOdsStreamingFactory

public interface AsamOdsFactoryIF

This is the interface that must be fulfilled by each AsamOdsFactory.

Since:

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

Version:

$Revision: 1.14 $

Author:

Andreas Hofmann

Method Summary

Methods

Modifier and Type	Method and Description
void	configSession(XSDContextIF ctx, AoSession aoSession, java.util.Properties context) Configure the session's context variables.
AoSession	connect(XSDContextIF context, java.lang.String refdef, Aosession descriptor, Filetransfer filetransfer) Create an ao session using the XML descriptor.
AIDName	create(XSDContextIF context, ApplicationElement aeObj, Aidname descriptor) Create a ASAM ODS AIDName structure from XML descriptor.
ApplicationAttribute	create(XSDContextIF context, ApplicationElement aeObj, Attribute descriptor) Create an application attribute from XML descriptor.
InstanceElement[]	create(XSDContextIF context, ApplicationElement aeObj, Instanceelement descriptor) Create an instance element from XML descriptor.
T_LONGLONG	create(XSDContextIF context, ApplicationElement aeObj, Unitid descriptor) Create a ASAM ODS id of a unit from XML descriptor.
NameValueUnit[]	create(XSDContextIF context, ApplicationElement aeObj, Value descriptor) Create a value from XML descriptor.
AIDName	create(XSDContextIF context, ApplicationStructure asObj, Aidname descriptor) Create a ASAM ODS AIDName structure from XML descriptor.
AIDNameUnitId	create(XSDContextIF context, ApplicationStructure asObj, Aidnameunitid descriptor) Create a ASAM ODS AIDNameUnit structure from aidnameunitid XML descriptor.
SelAIDNameUnitId[]	create(XSDContextIF context, ApplicationStructure asObj, Anuseq descriptor, java.util.List<java.lang.String> alias, java.util.List<FormatToStringIF> formats) Create a ASAM ODS SelAIDNameUnitId structure array from orderby XML descriptor.
ApplicationElement	create(XSDContextIF context, ApplicationStructure asObj, Applicationelement descriptor) Create an application element from XML descriptor.
ApplicationAttribute	create(XSDContextIF context, ApplicationStructure asObj, Attribute descriptor) Create an application attribute from XML descriptor.
SelItem[]	create(XSDContextIF context, ApplicationStructure asObj, Condseq descriptor) Create a ASAM ODS SelItem structure array from orderby XML descriptor.
AIDName[]	create(XSDContextIF context, ApplicationStructure asObj, Groupby descriptor) Create a ASAM ODS AIDName structure from groupby XML descriptor.
InstanceElement[]	create(XSDContextIF context, ApplicationStructure asObj, Instanceelement descriptor) Create an instance element from XML descriptor.
JoinDef	create(XSDContextIF context, ApplicationStructure asObj, Joindef descriptor) Create a ASAM ODS JoinDef structure from orderby XML descriptor.
JoinDef[]	create(XSDContextIF context, ApplicationStructure asObj, Joinseq descriptor) Create a ASAM ODS JoinDef structure array from orderby XML descriptor.
SelOrder[]	create(XSDContextIF context, ApplicationStructure asObj, Orderby descriptor) Create a ASAM ODS SelOrder structure from orderby XML descriptor.
QueryStructureExt	create(XSDContextIF context, ApplicationStructure asObj, Querystructureext descriptor, java.util.List<java.lang.String> alias, java.util.List<FormatToStringIF> formats) Create a ASAM ODS QueryStructureExt structure from XML descriptor.
SelAIDNameUnitId	create(XSDContextIF context, ApplicationStructure asObj, Selaidnameunitid descriptor) Create a ASAM ODS SelAIDNameUnit structure from aidnameunitid XML descriptor.
SelItem	create(XSDContextIF context, ApplicationStructure asObj, Selitem descriptor) Create a ASAM ODS SelItem structure from selitem XML descriptor.
SelOrder	create(XSDContextIF context, ApplicationStructure asObj, Selorder descriptor) Create a ASAM ODS SelOrder structure from XML descriptor.
SelValueExt	create(XSDContextIF context, ApplicationStructure asObj, Selvalueext descriptor) Create a ASAM ODS SelValueExt structure from aidnameunitid XML descriptor.
T_LONGLONG	create(XSDContextIF context, ApplicationStructure asObj, Unitid descriptor) Create a ASAM ODS id of a unit from XML descriptor.
NameValueUnit[]	create(XSDContextIF context, ApplicationStructure asObj, Value descriptor) Create a value from XML descriptor.
NameValueUnit[]	create(XSDContextIF context, InstanceElement[] ieObj, Value descriptor) Create a value from XML descriptor.
TS_Value	create(XSDContextIF context, TsValue descriptor) Create a ASAM ODS TS_Value from XML descriptor.
AoSession	createAoSession(AoSessionDescriptor descriptor) Create a asam ods session.
AoSession	createAoSession(AoSessionIORDescriptor descriptor) Create a asam ods session.
T_LONGLONG	createID(XSDContextIF context, ApplicationStructure asObj, Applicationelement descriptor) Create an application element ID from XML descriptor.
ElemId[]	createID(XSDContextIF context, ApplicationStructure asObj, Instanceelement descriptor) Create an instance element ID from XML descriptor.
TransferIF	createTransfer(XSDContextIF context, Filetransfer filetransfer) Create a transfer object.
NameValueUnit[]	createValue(InstanceElement[] ieObj, java.lang.String name, java.lang.String basename, java.lang.String unit) Create a Name Value Unit.

Method Detail

configSession

void configSession(XSDContextIF ctx,
                 AoSession aoSession,
                 java.util.Properties context)
                   throws AoException

Configure the session's context variables.

Parameters:

ctx - The runtime context.

aoSession - The session.

context - the properties containing the context values.

Throws:

AoException

connect

AoSession connect(XSDContextIF context,
                java.lang.String refdef,
                Aosession descriptor,
                Filetransfer filetransfer)
                  throws AoException,
                         java.lang.Exception

Create an ao session using the XML descriptor.
The session descriptor class (com.highqsoft.xsd.AoSessionDescriptor) will be save as reference at the context under the keyword composed by the id and the postfix DESCRIPTOR_POSTFIX.
The filetransfer object (com.highqsoft.xsd.TransferIF) will be save as reference at the context under the keyword composed by the id and the postfix FILETRANSFER_POSTFIX.

Parameters:

context - the runtime context.

refdef - the default reference name, may be null

descriptor - The JOB descriptor of a session.

Returns:

the session.

Throws:

AoException - If description is wrong.

java.lang.Exception

createTransfer

TransferIF createTransfer(XSDContextIF context,
                        Filetransfer filetransfer)
                          throws java.lang.Exception

Create a transfer object.

Parameters:

context - The context.

filetransfer - the XML description of the transfer.

Returns:

the tranfer interface.

Throws:

java.lang.Exception - if instantiation fails.

createAoSession

AoSession createAoSession(AoSessionDescriptor descriptor)
                          throws AoException

Create a asam ods session.

Parameters:

descriptor - the session description.

Returns:

the session.

Throws:

AoException

createAoSession

AoSession createAoSession(AoSessionIORDescriptor descriptor)
                          throws AoException

Create a asam ods session.

Parameters:

descriptor - the session IOR description.

Returns:

the session.

Throws:

AoException

create

ApplicationElement create(XSDContextIF context,
                        ApplicationStructure asObj,
                        Applicationelement descriptor)
                          throws AoException,
                                 java.text.ParseException

Create an application element from XML descriptor.

Parameters:

context - The XML context.

asObj - the application structure.

descriptor - the descriptor

Returns:

the application element

Throws:

AoException - if descriptor is wrong.

java.text.ParseException - if specification is not transformable.

create

ApplicationAttribute create(XSDContextIF context,
                          ApplicationStructure asObj,
                          Attribute descriptor)
                            throws AoException,
                                   java.text.ParseException

Create an application attribute from XML descriptor.

Parameters:

context - The XML context.

asObj - the application structure.

descriptor - the descriptor

Returns:

the application element

Throws:

AoException - if descriptor is wrong.

java.text.ParseException - if specification is not transformable.

create

ApplicationAttribute create(XSDContextIF context,
                          ApplicationElement aeObj,
                          Attribute descriptor)
                            throws AoException

Create an application attribute from XML descriptor.

Parameters:

context - The XML context.

aeObj - the application element.

descriptor - the descriptor

Returns:

the application attribute

Throws:

AoException - if descriptor is wrong.

create

InstanceElement[] create(XSDContextIF context,
                       ApplicationStructure asObj,
                       Instanceelement descriptor)
                         throws AoException,
                                java.text.ParseException

Create an instance element from XML descriptor.

Parameters:

context - The XML context.

asObj - the application structure.

descriptor - the descriptor

Returns:

the instance element array

Throws:

AoException - if descriptor is wrong.

java.text.ParseException - if specification is not transformable.

create

InstanceElement[] create(XSDContextIF context,
                       ApplicationElement aeObj,
                       Instanceelement descriptor)
                         throws AoException,
                                java.text.ParseException

Create an instance element from XML descriptor.

Parameters:

context - The XML context.

aeObj - the application element.

descriptor - the descriptor

Returns:

the instance element array

Throws:

AoException - if descriptor is wrong.

java.text.ParseException - if specification is not transformable.

create

NameValueUnit[] create(XSDContextIF context,
                     ApplicationStructure asObj,
                     Value descriptor)
                       throws AoException,
                              java.text.ParseException

Create a value from XML descriptor.

Parameters:

context - The XML context.

asObj - the application structure.

descriptor - the descriptor

Returns:

the ASAM ODS NameValueUnit structure array, or null when descriptor is wrong.

Throws:

AoException - if descriptor is wrong.

java.text.ParseException - if specification is not transformable.

create

NameValueUnit[] create(XSDContextIF context,
                     ApplicationElement aeObj,
                     Value descriptor)
                       throws AoException,
                              java.text.ParseException

Create a value from XML descriptor.

Parameters:

context - The XML context.

aeObj - the application element.

descriptor - the descriptor

Returns:

the ASAM ODS NameValueUnit structure array, or null when descriptor is wrong.

Throws:

AoException - if descriptor is wrong.

java.text.ParseException - if specification is not transformable.

create

NameValueUnit[] create(XSDContextIF context,
                     InstanceElement[] ieObj,
                     Value descriptor)
                       throws AoException

Create a value from XML descriptor.

Parameters:

context - The XML context.

ieObj - the instance element.

descriptor - the descriptor

Returns:

the ASAM ODS NameValueUnit structure, or null when descriptor is wrong.

Throws:

AoException - if descriptor is wrong.

createValue

NameValueUnit[] createValue(InstanceElement[] ieObj,
                          java.lang.String name,
                          java.lang.String basename,
                          java.lang.String unit)
                            throws AoException

Create a Name Value Unit.

Parameters:

ieObj - The instance element.

name - the name, it will be used before base, if available.

basename - the basename, that is used when name is not available.

unit - the unit string, that is used to get the value.

Returns:

a NameValueUnit ASAM ODS structure or null, if not enough information.

Throws:

AoException - if there is a wrong description

create

AIDName create(XSDContextIF context,
             ApplicationStructure asObj,
             Aidname descriptor)
               throws AoException,
                      java.text.ParseException

Create a ASAM ODS AIDName structure from XML descriptor.

Parameters:

context - The XML context.

asObj - the application structure.

descriptor - the descriptor

Returns:

the ASAM ODS AIDName structure, or null when descriptor is wrong.

Throws:

AoException - if descriptor is wrong.

java.text.ParseException

create

AIDName create(XSDContextIF context,
             ApplicationElement aeObj,
             Aidname descriptor)
               throws AoException,
                      java.text.ParseException

Create a ASAM ODS AIDName structure from XML descriptor.

Parameters:

context - The XML context.

aeObj - the application element.

descriptor - the descriptor

Returns:

the ASAM ODS AIDName structure, or null when descriptor is wrong.

Throws:

AoException - if descriptor is wrong.

java.text.ParseException

create

T_LONGLONG create(XSDContextIF context,
                ApplicationStructure asObj,
                Unitid descriptor)
                  throws AoException,
                         java.text.ParseException

Create a ASAM ODS id of a unit from XML descriptor.

Parameters:

context - The XML context.

asObj - the application structure.

descriptor - the descriptor

Returns:

the ASAM ODS unit id, or null when descriptor is wrong.

Throws:

AoException - if descriptor is wrong.

java.text.ParseException

create

T_LONGLONG create(XSDContextIF context,
                ApplicationElement aeObj,
                Unitid descriptor)
                  throws AoException,
                         java.text.ParseException

Create a ASAM ODS id of a unit from XML descriptor.

Parameters:

context - The XML context.

aeObj - the application element of base type aounit.

descriptor - the descriptor

Returns:

the ASAM ODS unit id, or null when descriptor is wrong.

Throws:

AoException - if descriptor is wrong.

java.text.ParseException

create

TS_Value create(XSDContextIF context,
              TsValue descriptor)
                throws AoException,
                       java.text.ParseException

Create a ASAM ODS TS_Value from XML descriptor.

Parameters:

context - The XML context.

descriptor - the descriptor

Returns:

the ASAM ODS TS_Value, or null when descriptor is wrong.

Throws:

AoException - if descriptor is wrong.

java.text.ParseException

create

AIDName[] create(XSDContextIF context,
               ApplicationStructure asObj,
               Groupby descriptor)
                 throws AoException,
                        java.text.ParseException

Create a ASAM ODS AIDName structure from groupby XML descriptor.

Parameters:

context - The XML context.

asObj - the application structure.

descriptor - the descriptor

Returns:

the ASAM ODS AIDName structure array, or null when descriptor is wrong.

Throws:

AoException - if descriptor is wrong.

java.text.ParseException

create

SelOrder create(XSDContextIF context,
              ApplicationStructure asObj,
              Selorder descriptor)
                throws AoException,
                       java.text.ParseException

Create a ASAM ODS SelOrder structure from XML descriptor.

Parameters:

context - The XML context.

asObj - the application structure.

descriptor - the descriptor

Returns:

the ASAM ODS SelOrder structure array, or null when descriptor is wrong.

Throws:

AoException - if descriptor is wrong.

java.text.ParseException

create

SelOrder[] create(XSDContextIF context,
                ApplicationStructure asObj,
                Orderby descriptor)
                  throws AoException,
                         java.text.ParseException

Create a ASAM ODS SelOrder structure from orderby XML descriptor.

Parameters:

context - The XML context.

asObj - the application structure.

descriptor - the descriptor

Returns:

the ASAM ODS SelOrder structure array, or null when descriptor is wrong.

Throws:

AoException - if descriptor is wrong.

java.text.ParseException

create

JoinDef create(XSDContextIF context,
             ApplicationStructure asObj,
             Joindef descriptor)
               throws AoException,
                      java.text.ParseException

Create a ASAM ODS JoinDef structure from orderby XML descriptor.

Parameters:

context - The XML context.

asObj - the application structure.

descriptor - the descriptor

Returns:

the ASAM ODS JoinDef structure, or null when descriptor is wrong.

Throws:

AoException - if descriptor is wrong.

java.text.ParseException

create

JoinDef[] create(XSDContextIF context,
               ApplicationStructure asObj,
               Joinseq descriptor)
                 throws AoException,
                        java.text.ParseException

Create a ASAM ODS JoinDef structure array from orderby XML descriptor.

Parameters:

context - The XML context.

asObj - the application structure.

descriptor - the descriptor

Returns:

the ASAM ODS JoinDef structure array, or null when descriptor is wrong.

Throws:

AoException - if descriptor is wrong.

java.text.ParseException

create

AIDNameUnitId create(XSDContextIF context,
                   ApplicationStructure asObj,
                   Aidnameunitid descriptor)
                     throws AoException,
                            java.text.ParseException

Create a ASAM ODS AIDNameUnit structure from aidnameunitid XML descriptor.

Parameters:

context - The XML context.

asObj - the application structure.

descriptor - the descriptor

Returns:

the ASAM ODS JoinDef structure, or null when descriptor is wrong.

Throws:

AoException - if descriptor is wrong.

java.text.ParseException

create

SelAIDNameUnitId create(XSDContextIF context,
                      ApplicationStructure asObj,
                      Selaidnameunitid descriptor)
                        throws AoException,
                               java.text.ParseException

Create a ASAM ODS SelAIDNameUnit structure from aidnameunitid XML descriptor.

Parameters:

context - The XML context.

asObj - the application structure.

descriptor - the descriptor

Returns:

the ASAM ODS JoinDef structure, or null when descriptor is wrong.

Throws:

AoException - if descriptor is wrong.

java.text.ParseException

create

SelAIDNameUnitId[] create(XSDContextIF context,
                        ApplicationStructure asObj,
                        Anuseq descriptor,
                        java.util.List<java.lang.String> alias,
                        java.util.List<FormatToStringIF> formats)
                          throws AoException,
                                 java.text.ParseException

Create a ASAM ODS SelAIDNameUnitId structure array from orderby XML descriptor.

Parameters:

context - The XML context.

asObj - the application structure.

descriptor - the descriptor

alias - A list that is used to return the alias names.

formats - A list that is used to return the format strings.

Returns:

the ASAM ODS SelAIDNameUnitId structure array, or null when descriptor is wrong.

Throws:

AoException - if descriptor is wrong.

java.text.ParseException

create

SelValueExt create(XSDContextIF context,
                 ApplicationStructure asObj,
                 Selvalueext descriptor)
                   throws AoException,
                          java.text.ParseException

Create a ASAM ODS SelValueExt structure from aidnameunitid XML descriptor.

Parameters:

context - The XML context.

asObj - the application structure.

descriptor - the descriptor

Returns:

the ASAM ODS SelValueExt structure, or null when descriptor is wrong.

Throws:

AoException - if descriptor is wrong.

java.text.ParseException

create

SelItem[] create(XSDContextIF context,
               ApplicationStructure asObj,
               Condseq descriptor)
                 throws AoException,
                        java.text.ParseException

Create a ASAM ODS SelItem structure array from orderby XML descriptor.

Parameters:

context - The XML context.

asObj - the application structure.

descriptor - the descriptor

Returns:

the ASAM ODS SelValueExt structure array, or null when descriptor is wrong.

Throws:

AoException - if descriptor is wrong.

java.text.ParseException

create

SelItem create(XSDContextIF context,
             ApplicationStructure asObj,
             Selitem descriptor)
               throws AoException,
                      java.text.ParseException

Create a ASAM ODS SelItem structure from selitem XML descriptor.

Parameters:

context - The XML context.

asObj - the application structure.

descriptor - the descriptor

Returns:

the ASAM ODS SelItem structure, or null when descriptor is wrong.

Throws:

AoException - if descriptor is wrong.

java.text.ParseException

create

QueryStructureExt create(XSDContextIF context,
                       ApplicationStructure asObj,
                       Querystructureext descriptor,
                       java.util.List<java.lang.String> alias,
                       java.util.List<FormatToStringIF> formats)
                         throws AoException,
                                java.text.ParseException

Create a ASAM ODS QueryStructureExt structure from XML descriptor.

Parameters:

context - The XML context.

asObj - the application structure.

descriptor - the descriptor

alias - A list that is used to return the alias names.

formats - A list that is used to return the format strings.

Returns:

the ASAM ODS QueryStructureExt structure, or null when descriptor is wrong.

Throws:

AoException - if descriptor is wrong.

java.text.ParseException

createID

T_LONGLONG createID(XSDContextIF context,
                  ApplicationStructure asObj,
                  Applicationelement descriptor)
                    throws AoException,
                           java.text.ParseException

Create an application element ID from XML descriptor.

Parameters:

context - The XML context.

asObj - the application structure.

descriptor - the descriptor

Returns:

the application element.

Throws:

AoException - if descriptor is wrong.

java.text.ParseException - if specification is not transformable.

createID

ElemId[] createID(XSDContextIF context,
                ApplicationStructure asObj,
                Instanceelement descriptor)
                  throws AoException,
                         java.text.ParseException

Create an instance element ID from XML descriptor.

Parameters:

context - The XML context.

asObj - the application structure.

descriptor - the descriptor

Returns:

the instance element array

Throws:

AoException - if descriptor is wrong.

java.text.ParseException - if specification is not transformable.