com.highqsoft.dropper

Class Dropper

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.dropper.Dropper

All Implemented Interfaces:

ExecutableIF, ImplementationIF

public class Dropper
extends AbstractImplementation
implements ExecutableIF

This is the Dropper executor. It can be used to execute dropper xml files directly from command line by passing the filename or url as first command line argument to that class. The object of this class will save itself as reference using the constant Dropper.DROPPER_REF_NAME.

Since:

$Date: 2018/10/10 06:21:17 $

Version:

$Revision: 1.23 $

Author:

Andreas Hofmann

See Also:

ImplementationIF

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CACHE_REF_NAME The cache reference name (value="DROPPER_CACHE").
static java.lang.String	DROPPER_REF_NAME The dropper reference name (value="DROPPER").
static java.lang.String	ODSCACHEFIELD This is the reference name of the ASAM ODS change.
static java.lang.String	REFERENCEFIELD This is the reference name of the referencefield, that holds the file references.
static java.lang.String	TARGETFIELD This is the reference name of the targetfield, that holds the ids to be deleted.

Fields inherited from class com.highqsoft.xsd.AbstractImplementation

arguments, ctx, descriptor, NEW_LINE

Constructor Summary

Constructors

Constructor and Description
Dropper() Create the using a context.
Dropper(XSDContextIF ctx) The transformer constructor.
Dropper(XSDContextIF ctx, Dropper dropperXSD) Create the Dropper using a context.
Dropper(XSDContextIF ctx, java.util.Properties properties) The transformer constructor.
Dropper(XSDContextIF ctx, java.util.Properties arguments, Dropper dropperXSD) Create the Dropper using a context.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(ElemId id, boolean recursive, boolean delete, boolean deletefiles, boolean deleterefs) Add elem Ids to the dropper list.
void	add(TargetElement element) Add an element to the dropper list.
protected static void	checkDescriptor(java.lang.Object descriptor) Check the descriptor.
static Dropper	createInstance(XSDContextIF ctx, java.io.InputStream is) Use this method to create a Dropper object from XML input stream
static Dropper	createInstance(XSDContextIF ctx, java.lang.String buf) Use this method to create a Dropper object XML string
static Dropper	createInstance(XSDContextIF ctx, java.lang.String[] buf) Use this method to create a Dropper object from XML string array
static Dropper	createInstance(XSDContextIF ctx, java.lang.StringBuffer buf) Use this method to create a object from XML string buffer
AoSession	createSession() Create a session from XML aosession descriptor.
void	dropFiles(CORBAFileServerIF server) Drop the files.
protected void	dropTargets() Drop the targets.
void	dump() Dump the id to the file.
void	dumpRefs(java.io.PrintStream printer) Dump the references to the file.
void	dumpTargets(java.io.PrintStream printer) Dump the id to the file.
void	execute() Execute the dropper.
protected static void	execute(XSDContextIF ctx, ExecutableIF executable, java.util.logging.Logger messenger, java.lang.String classname, java.lang.String method) Execute an implementation.
static void	executeSequence(XSDContextIF ctx, java.lang.String classname, java.lang.String ident, Implementationseq implSeq) Execute a sequence of executable interfaces.
java.util.Vector<TargetElement>	getAll() Get all elements of the dropper list.
static java.lang.String	getLocalFilename(XSDContextIF ctx, java.lang.String filename) Get the local filename.
int	getMaxRows() Get the total number rows to be selected.
java.lang.String	getReferenceField() Get the external reference reference name.
AoSession	getSession() Get the internal session.
java.lang.String	getTargetField() Get the target id reference name.
boolean	handleTransaction() Get the simulate flag.
void	init() Initialize the program.
boolean	isSimulate() Get the simulate flag.
static void	main(java.lang.String[] args) The main program to execute an Dropper XML fromn commandline.
void	setDescriptor(java.lang.Object descriptor) Set the XML tree descriptor.
void	setReferenceField(java.lang.String referencefield) Set the external reference reference name.
void	setSession(AoSession aoSession) Set the session.
void	setTargetField(java.lang.String targetField) Set the target id reference name.
void	terminate() Terminate the dropper.

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

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

Field Detail

DROPPER_REF_NAME

public static final java.lang.String DROPPER_REF_NAME

The dropper reference name (value="DROPPER").

See Also:

Constant Field Values

CACHE_REF_NAME

public static final java.lang.String CACHE_REF_NAME

The cache reference name (value="DROPPER_CACHE").

See Also:

Constant Field Values

ODSCACHEFIELD

public static final java.lang.String ODSCACHEFIELD

This is the reference name of the ASAM ODS change.

See Also:

Constant Field Values

TARGETFIELD

public static final java.lang.String TARGETFIELD

This is the reference name of the targetfield, that holds the ids to be deleted.

See Also:

Constant Field Values

REFERENCEFIELD

public static final java.lang.String REFERENCEFIELD

This is the reference name of the referencefield, that holds the file references.

See Also:

Constant Field Values

Constructor Detail

Dropper

public Dropper()

Create the using a context.

Dropper

public Dropper(XSDContextIF ctx)
        throws InvalidArgumentException,
               InvalidDescriptorException

The transformer constructor. Descriptor will be taken from context.

Parameters:

ctx - the context in that the model mapper should run.

Throws:

InvalidArgumentException

InvalidDescriptorException

Dropper

public Dropper(XSDContextIF ctx,
       java.util.Properties properties)
        throws InvalidArgumentException,
               InvalidDescriptorException

The transformer constructor. Descriptor will be taken from context.

Parameters:

ctx - the context in that the model mapper should run.

properties - the arguments.

Throws:

InvalidArgumentException

InvalidDescriptorException

Dropper

public Dropper(XSDContextIF ctx,
       java.util.Properties arguments,
       Dropper dropperXSD)
        throws InvalidArgumentException,
               InvalidDescriptorException

Create the Dropper using a context.

Parameters:

ctx - the context in that the query should run.

arguments - the arguments (may be null)

dropperXSD - the XML tree node of the drop job.

Throws:

InvalidArgumentException - if arguments are invalid.

InvalidDescriptorException - if descriptor is invalid.

Dropper

public Dropper(XSDContextIF ctx,
       Dropper dropperXSD)
        throws InvalidArgumentException,
               InvalidDescriptorException

Create the Dropper using a context.

Parameters:

ctx - the context in that the query should run.

dropperXSD - the XML tree node of the drop job.

Throws:

InvalidArgumentException - if arguments are invalid.

InvalidDescriptorException - if descriptor is invalid.

Method Detail

createInstance

public static Dropper createInstance(XSDContextIF ctx,
                     java.lang.StringBuffer buf)
                              throws java.io.FileNotFoundException,
                                     javax.xml.bind.JAXBException,
                                     java.io.IOException,
                                     InvalidArgumentException,
                                     InvalidDescriptorException,
                                     InitializationFailedException

Use this method to create a object from XML string buffer

Parameters:

ctx - the context

buf - the string buffer

Returns:

the Dropper object.

Throws:

java.io.FileNotFoundException - if schema file was not found.

javax.xml.bind.JAXBException - if the XML context was wrong.

java.io.IOException - if an IO problem occurs.

InvalidArgumentException - if there are wrong arguments for the implementation.

InvalidDescriptorException - if the descriptor is wrong.

InitializationFailedException - if initialization fails.

createInstance

public static Dropper createInstance(XSDContextIF ctx,
                     java.lang.String[] buf)
                              throws java.io.FileNotFoundException,
                                     javax.xml.bind.JAXBException,
                                     java.io.IOException,
                                     InvalidArgumentException,
                                     InvalidDescriptorException,
                                     InitializationFailedException

Use this method to create a Dropper object from XML string array

Parameters:

ctx - the context

buf - the string array

Returns:

the Dropper object.

Throws:

java.io.FileNotFoundException - if schema file was not found.

javax.xml.bind.JAXBException - if the XML context was wrong.

java.io.IOException - if an IO problem occurs.

InvalidArgumentException - if there are wrong arguments for the implementation.

InvalidDescriptorException - if the descriptor is wrong.

InitializationFailedException - if initialization fails.

createInstance

public static Dropper createInstance(XSDContextIF ctx,
                     java.lang.String buf)
                              throws java.io.FileNotFoundException,
                                     javax.xml.bind.JAXBException,
                                     java.io.IOException,
                                     InvalidArgumentException,
                                     InvalidDescriptorException,
                                     InitializationFailedException

Use this method to create a Dropper object XML string

Parameters:

ctx - the context

buf - the string

Returns:

the Dropper object.

Throws:

java.io.FileNotFoundException - if schema file was not found.

javax.xml.bind.JAXBException - if the XML context was wrong.

java.io.IOException - if an IO problem occurs.

InvalidArgumentException - if there are wrong arguments for the implementation.

InvalidDescriptorException - if the descriptor is wrong.

InitializationFailedException - if initialization fails.

createInstance

public static Dropper createInstance(XSDContextIF ctx,
                     java.io.InputStream is)
                              throws java.io.FileNotFoundException,
                                     javax.xml.bind.JAXBException,
                                     java.io.IOException,
                                     InvalidArgumentException,
                                     InvalidDescriptorException,
                                     InitializationFailedException

Use this method to create a Dropper object from XML input stream

Parameters:

ctx - the context

is - the input stream

Returns:

the Dropper object.

Throws:

java.io.FileNotFoundException - if schema file was not found.

javax.xml.bind.JAXBException - if the XML context was wrong.

java.io.IOException - if an IO problem occurs.

InvalidArgumentException - if there are wrong arguments for the implementation.

InvalidDescriptorException - if the descriptor is wrong.

InitializationFailedException - if initialization fails.

setDescriptor

public void setDescriptor(java.lang.Object descriptor)
                   throws InvalidDescriptorException

Set the XML tree descriptor.

Specified by:

setDescriptor in interface ImplementationIF

Overrides:

setDescriptor in class AbstractImplementation

Parameters:

descriptor - the tree node.

Throws:

InvalidDescriptorException - if descriptor is not valid.

checkDescriptor

protected static void checkDescriptor(java.lang.Object descriptor)
                               throws InvalidDescriptorException

Check the descriptor.

Parameters:

descriptor - the descriptor.

Throws:

InvalidDescriptorException - if descriptor is invliad.

init

public void init()
          throws InitializationFailedException

Initialize the program.

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - if initialization fails.

setTargetField

public void setTargetField(java.lang.String targetField)

Set the target id reference name. If the given value is null, the methods tries to read the following property from context:

• targetfield
• TargetField
• TARGETFIELD

If none of this alternative are available, the methods takes the value ELEMIDFIELD.

Parameters:

targetField - the new value.

getMaxRows

public int getMaxRows()

Get the total number rows to be selected.

Returns:

the total number.

isSimulate

public boolean isSimulate()

Get the simulate flag.

Returns:

true if the simulate mode is active.

handleTransaction

public boolean handleTransaction()

Get the simulate flag.

Returns:

true if the simulate mode is active.

getTargetField

public java.lang.String getTargetField()

Get the target id reference name.

Returns:

the name.

setReferenceField

public void setReferenceField(java.lang.String referencefield)

Set the external reference reference name. If the given value is null, the methods tries to read the following property from context:

• referencefield
• ReferenceField
• REFERENCEFIELD

If none of this alternative are available, the methods takes the value REFERENCEFIELD.

Parameters:

referencefield - the new value.

getReferenceField

public java.lang.String getReferenceField()

Get the external reference reference name.

Returns:

the name.

execute

public void execute()
             throws ExecutableException

Execute the dropper.

Specified by:

execute in interface ExecutableIF

Throws:

ExecutableException - if execution fails.

add

public void add(ElemId id,
       boolean recursive,
       boolean delete,
       boolean deletefiles,
       boolean deleterefs)

Add elem Ids to the dropper list.

Parameters:

id - the element id.

recursive - true if this element should be dropped recursively.

delete - true if element should be dropped.

deletefiles - true if external references should also be deleted.

deleterefs - true if cold references should also be deleted.

add

public void add(TargetElement element)

Add an element to the dropper list.

Parameters:

element - the new target element.

dropTargets

protected void dropTargets()
                    throws AoException

Drop the targets.

Throws:

AoException - if ASAm ODS fails.

dropFiles

public void dropFiles(CORBAFileServerIF server)

Drop the files.

Parameters:

server - the CROAB files server instance.

getAll

public java.util.Vector<TargetElement> getAll()

Get all elements of the dropper list.

dumpTargets

public void dumpTargets(java.io.PrintStream printer)
                 throws java.io.IOException

Dump the id to the file.

Parameters:

printer - the printer.

Throws:

java.io.IOException - if printing fails.

dumpRefs

public void dumpRefs(java.io.PrintStream printer)
              throws java.io.IOException

Dump the references to the file.

Parameters:

printer - the printer.

Throws:

java.io.IOException - if printing fails.

dump

public void dump()
          throws java.io.IOException

Dump the id to the file.

Throws:

java.io.IOException - if printing fails.

terminate

public void terminate()

Terminate the dropper.

Specified by:

terminate in interface ExecutableIF

executeSequence

public static void executeSequence(XSDContextIF ctx,
                   java.lang.String classname,
                   java.lang.String ident,
                   Implementationseq implSeq)
                            throws java.io.FileNotFoundException,
                                   InvalidDescriptorException,
                                   InvalidArgumentException,
                                   InitializationFailedException,
                                   java.io.IOException,
                                   java.lang.ClassNotFoundException,
                                   java.lang.InstantiationException,
                                   java.lang.IllegalAccessException

Execute a sequence of executable interfaces.

Parameters:

ident - The method ident.

implSeq - the sequence.

Throws:

java.lang.IllegalAccessException

java.lang.InstantiationException

java.lang.ClassNotFoundException

java.io.IOException

InitializationFailedException

InvalidArgumentException

InvalidDescriptorException

java.io.FileNotFoundException

execute

protected static void execute(XSDContextIF ctx,
           ExecutableIF executable,
           java.util.logging.Logger messenger,
           java.lang.String classname,
           java.lang.String method)

Execute an implementation.

Parameters:

ctx - the context.

executable - the executable definition.

messenger - the messenger.

method - the name of the method that calls this method.

setSession

public void setSession(AoSession aoSession)
                throws AoException

Set the session.

Parameters:

aoSession - the ASAM ODS session.

Throws:

AoException - if ASAM ODS call fails.

createSession

public AoSession createSession()
                        throws AoException,
                               java.lang.Exception

Create a session from XML aosession descriptor.
This methods tries to get the session from the reference assigned by the sessionref attribute first. If this fails it tries to get the session defined by the session node of the XML structure.

Returns:

the session or null

Throws:

AoException

java.lang.Exception

getSession

public AoSession getSession()

Get the internal session.

Returns:

the ASAM ODS session.

main

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

The main program to execute an Dropper XML fromn commandline. The first argument must be the filename, resource or url that should be used.

Parameters:

args - the command line arguments.

getLocalFilename

public static java.lang.String getLocalFilename(XSDContextIF ctx,
                                java.lang.String filename)
                                         throws java.io.IOException

Get the local filename. This routine tries to find a local file specification. If that fails, it tries to resolve a the relative filename in classpath and tries get a local file.

Parameters:

a - filename spec.

Throws:

java.io.IOException