org.xmlactions.db.actions

Class Storage

java.lang.Object

org.xmlactions.action.actions.BaseAction

org.xmlactions.db.actions.Storage

public class Storage
extends BaseAction

Field Summary

Fields inherited from class org.xmlactions.action.actions.BaseAction

CHILD, CONTENT

Constructor Summary

Constructors

Constructor and Description
Storage()

Method Summary

Modifier and Type	Method and Description
void	completeStructure() Completes the database definition structure.
java.lang.String	execute(IExecContext context) Executes an action
Database	getDatabase()
Database	getDatabase(java.lang.String name) Get a database by it's name.
java.util.List<Database>	getDatabases()
Database	getFirstDatabase()
Xml	getFirstXml()
java.lang.String	getName()
java.util.List<Xml>	getXmls()
void	processInserts(IExecContext execContext) A database may contain DBInserts that are used to insert databases from other files.
void	setDatabase(Database database)
void	setName(java.lang.String name)
void	setXml(Xml xml)
java.lang.String	toString(int indent)

Methods inherited from class org.xmlactions.action.actions.BaseAction

addChild, clearActions, doReplace, doReplace, getActions, getChild, getContent, getFirstValueFound, getParent, getReplacementContent, getReplacementMarker, isUsedForDisplay, processAction, setAction, setActions, setChild, setContent, setParent, setReplacementContent, setReplacementMarker, setUsedForDisplay

Methods inherited from class java.lang.Object

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

Constructor Detail

Storage

public Storage()

Method Detail

execute

public java.lang.String execute(IExecContext context)
                         throws java.lang.Exception

Description copied from class: BaseAction

Executes an action

Specified by:

execute in class BaseAction

Parameters:

context - the application execution context

Returns:

a String for replacement and to execute any child actions, else null to skip over child actions.

Throws:

java.lang.Exception

setDatabase

public void setDatabase(Database database)

getDatabase

public Database getDatabase()

Returns:

the last database added.

getFirstDatabase

public Database getFirstDatabase()

Returns:

the first database.

getDatabase

public Database getDatabase(java.lang.String name)
                     throws java.lang.IllegalArgumentException

Get a database by it's name.

If name is empty it will return the first database in the configuration. This behavior is implemented as most configurations will only contain one database.

Parameters:

name - the name of the database we want to use, may be empty if we are only using one database.

Returns:

the database

Throws:

java.lang.IllegalArgumentException - if the database cannot be found

getDatabases

public java.util.List<Database> getDatabases()

toString

public java.lang.String toString(int indent)

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

setXml

public void setXml(Xml xml)

getXmls

public java.util.List<Xml> getXmls()

getFirstXml

public Xml getFirstXml()

completeStructure

public void completeStructure()

Completes the database definition structure.

1. Build backward links to foreign table FKs.

processInserts

public void processInserts(IExecContext execContext)
                    throws java.lang.Exception

A database may contain DBInserts that are used to insert databases from other files. This method calls the insertion process.

Parameters:

execContext -

Throws:

java.lang.Exception