com.highqsoft.schemabox.ods

Class Enumeration

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.schemabox.ods.Enumeration

All Implemented Interfaces:

ExecutableIF, ImplementationIF

public class Enumeration
extends AbstractImplementation
implements ExecutableIF

This class is used to modify ODS Enumerations in a datasource.
The following table lists all the argument of this implementation. Keywords are case insensitive. The DATA argument needs special attention. The code has to be in ODS XATF compatible format for the program to evaluate. An example would be as follows:

 <text><!-[CDATA][
    <application_enumeration>
       <name>testenum</name>
       <item>
          <name>Banana</name>
          <value>1</value>
       </item>
    </application_enumeration>
 ]</text>
 

If the DATA argument contains only the enumeration tag and its name, the whole enumeration will be deleted. If however one or more items are present, the inmplementation is supposed to delete the selected items and leave the rest of the enumeration standing.

ATTENTION: the selective delete has not been implemented yet!

Argument Keyword	Datatype	Default	Description
Operation	String	none	The Operation to be done. Can be ADD or REMOVE.
Data	String	none	The Enumeration Data. Must be in ODS-XATF form and enveloped by a <!-[CDATA[]]> tag
TargetRef	String	target	The reference name to the session.

Author:

Alexander Ziller, HighQSoft GmbH

Field Summary

Fields inherited from class com.highqsoft.xsd.AbstractImplementation

arguments, ctx, descriptor, NEW_LINE

Constructor Summary

Constructors

Constructor and Description
Enumeration()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	enumExists(java.lang.String enumname) Checks if the given enumeration exists in the Server.
void	execute() Do the work.
protected AoSession	getSession() Get the session.
void	init() Initialize the work.
void	terminate() Terminate the execution.

Methods inherited from class com.highqsoft.xsd.AbstractImplementation

addAttributesToNameValueUnitArray, addAttributeToNameValueUnitArray, addStringValueToNameValueUnitArray, checkDirectoy, checkDirectoy, checkDirectoy, checkFile, checkFile, checkFile, checkIntValue, checkStringValue, compressNvuArray, createMessageFromPropertyFile, createMessageFromPropertyFile, createMessageFromPropertyFile, createTsUnionFromObject, deleteRowWithAttributes, getArguments, getContext, getDescriptor, getListFromProperty, getMandatoryProperty, getMandatoryProperty, getMandatoryPropertyAsInt, getMandatoryPropertyAsList, getMandatoryPropertyWithRuleException, getNvuArrayFromMap, getNvuArrayFromMap, getNvuObjectWithName, getNvuObjectWithName, getNvuObjectWithName, getOdsCacheFromProperty, getOptioanlPropertyAsInt, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsList, makeUpperCaseKeyword, removeAttributeFromNameValueUnitArray, removeAttributeFromNameValueUnitArray, setArguments, setContext, setDescriptor

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.xsd.ImplementationIF

getContext, getDescriptor, setArguments, setContext, setDescriptor

Constructor Detail

Enumeration

public Enumeration()

Method Detail

getSession

protected AoSession getSession()

Get the session.

Returns:

the ASAM ODS session.

init

public void init()
          throws InitializationFailedException

Description copied from class: AbstractImplementation

Initialize the work.

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - if the initialization fails.

execute

public void execute()
             throws ExecutableException

Do the work.

Specified by:

execute in interface ExecutableIF

Throws:

ExecutableException - if execution fails.

terminate

public void terminate()
               throws TerminationException

Description copied from interface: ExecutableIF

Terminate the execution.

Specified by:

terminate in interface ExecutableIF

Throws:

TerminationException - if termination fails.

enumExists

protected boolean enumExists(java.lang.String enumname)

Checks if the given enumeration exists in the Server.

Parameters:

enumname - the Enumeration Name

Returns:

true if it exists, false if not.