org.mmbase.applications.editwizard
Class Wizard

java.lang.Object
  |
  +--org.mmbase.applications.editwizard.Wizard

All Implemented Interfaces:

SizeMeasurable

public class Wizard

extends java.lang.Object

implements SizeMeasurable

EditWizard

Since:

MMBase-1.6

Version:

$Id: Wizard.java,v 1.74.2.18 2003/08/08 08:19:42 michiel Exp $

Author:

Kars Veling, Michiel Meeuwissen, Pierre van Rooden, Hillebrand Gelderblom

Constructor Summary

Wizard(java.lang.String context, URIResolver uri, Config.WizardConfig wizardConfig, Cloud cloud)
Constructor.

Wizard(java.lang.String context, URIResolver uri, java.lang.String wizardname, java.lang.String dataid, Cloud cloud)
Deprecated. use Wizard(String, URIResolver, Config.WizardConfig, Cloud)

Method Summary

void	addBinaryData(org.w3c.dom.Node fieldnode) This method stores binary data in the data, so that the information can be used by the html.
protected boolean	checkNode(java.lang.String objectNumber, java.lang.String operation) Returns true if the specified operation is valid for the node with the specified objectnumber.
boolean	committed() Returns whether the wizard may be closed
org.w3c.dom.Document	createPreHtml(org.w3c.dom.Node wizardSchema, java.lang.String formid, org.w3c.dom.Node data, java.lang.String instanceName) This method generated the pre-html.
org.w3c.dom.Document	createPreHtml(java.lang.String instanceName) This method generates the pre-html.
void	createPreHtmlForm(org.w3c.dom.Node form, org.w3c.dom.Node formdef, org.w3c.dom.Node data) This method is used by the #createPreHtml method to generate a pre-html form.
java.lang.String	determineNextForm(java.lang.String direction) This method is used to determine what form is the sequential next, previous, first etc.
byte[]	getBinary(java.lang.String did) This method allows you to retrieve the data of a temporarily stored binary.
java.lang.String	getBinaryName(java.lang.String did) With this method you can retrieve the binaryname of a placed binary.
java.lang.String	getBinaryPath(java.lang.String did) With this method you can retrieve the binarypath of a placed binary.
int	getByteSize() Determins the byte-size of this object
int	getByteSize(SizeOf sizeof) Determins the byte-size of this object using the given SizeOf instance.
org.w3c.dom.Node	getConstraints(java.lang.String objecttype) This method gets the MMBase constraints.
org.w3c.dom.Node	getConstraints(java.lang.String objecttype, java.lang.String fieldname) This method gets the MMBase constraints.
org.w3c.dom.Document	getData()
java.lang.String	getDataId()
java.lang.String	getObjectNumber()
org.w3c.dom.Document	getPreForm()
org.w3c.dom.Document	getPreForm(java.lang.String instanceName)
org.w3c.dom.Document	getSchema()
WizardCommand	getStartWizardCommand() Returns the subwizard start command
protected void	loadWizard(Config.WizardConfig wizardConfig) Loads the wizard schema, and a work document, and fills it with initial data.
boolean	mayBeClosed() Returns whether the wizard may be closed
protected boolean	mayDeleteNode(java.lang.String objectNumber) Returns true if the node with the specified objectnumber can be deleted
protected boolean	mayEditNode(java.lang.String objectNumber) Returns true if the node with the specified objectnumber can be edited
void	mergeConstraints(org.w3c.dom.Node fieldDef, org.w3c.dom.Node fieldNode) This method is used to merge MMBase specific constraints with the values placed in the Wizard definition.
void	processCommand(WizardCommand cmd) This method is usually called by #processCommands and processes one command.
void	processRequest(javax.servlet.ServletRequest req) Processes an incoming request (usually passed on by a jsp code).
void	setBinary(java.lang.String did, byte[] data, java.lang.String name, java.lang.String path) With this method you can store a binary in the wizard.
void	setReferrer(java.lang.String s)
void	setSessionId(java.lang.String s)
void	setSessionKey(java.lang.String s)
void	setTemplatesDir(java.lang.String f)
boolean	startWizard() Returns whether a sub wizard should be started
protected void	storeConfigurationAttributes(Config.WizardConfig wizardConfig) Stores configuration variables as attributes in the variabless set.
void	writeHtmlForm(java.io.Writer out, java.lang.String instanceName) Constructs and writes final form-html to the given out writer.

Methods inherited from class java.lang.Object

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

Constructor Detail

Wizard

public Wizard(java.lang.String context,
              URIResolver uri,
              java.lang.String wizardname,
              java.lang.String dataid,
              Cloud cloud)
       throws WizardException

Deprecated. use Wizard(String, URIResolver, Config.WizardConfig, Cloud)

Constructor. Setup initial variables and connects to mmbase to load the data structure.

Parameters:

context - the editwizard context path

uri - the URIResolver with which the wizard schema's and the xsl's will be loaded

wizardname - name of teh wizard

dataid - the objectnumber

cloud - the Cloud to use

Wizard

public Wizard(java.lang.String context,
              URIResolver uri,
              Config.WizardConfig wizardConfig,
              Cloud cloud)
       throws WizardException

Constructor. Setup initial variables and connects to mmbase to load the data structure.

Parameters:

context - the editwizard context path

uri - the URIResolver with which the wizard schema's and the xsl's will be loaded

wizardConfig - the class containing the configuration parameters (i.e. wizard name and objectnumber)

cloud - the Cloud to use

Method Detail

getByteSize

public int getByteSize()

Description copied from interface: SizeMeasurable

Determins the byte-size of this object

Specified by:

getByteSize in interface SizeMeasurable

getByteSize

public int getByteSize(SizeOf sizeof)

Description copied from interface: SizeMeasurable

Determins the byte-size of this object using the given SizeOf instance. A SizeOf instance stores a Set already counted objects. So this method is typically called by SizeOf itself (recursion).

Specified by:

getByteSize in interface SizeMeasurable

setSessionId

public void setSessionId(java.lang.String s)

setSessionKey

public void setSessionKey(java.lang.String s)

setReferrer

public void setReferrer(java.lang.String s)

setTemplatesDir

public void setTemplatesDir(java.lang.String f)

getObjectNumber

public java.lang.String getObjectNumber()

getDataId

public java.lang.String getDataId()

getData

public org.w3c.dom.Document getData()

getSchema

public org.w3c.dom.Document getSchema()

getPreForm

public org.w3c.dom.Document getPreForm()
                                throws WizardException

getPreForm

public org.w3c.dom.Document getPreForm(java.lang.String instanceName)
                                throws WizardException

committed

public boolean committed()

Returns whether the wizard may be closed

mayBeClosed

public boolean mayBeClosed()

Returns whether the wizard may be closed

startWizard

public boolean startWizard()

Returns whether a sub wizard should be started

checkNode

protected boolean checkNode(java.lang.String objectNumber,
                            java.lang.String operation)
                     throws WizardException

Returns true if the specified operation is valid for the node with the specified objectnumber. The operation is valid if the node has the given property set to true. To maintain backwards compatible, if the property is not given, the default value is true.

Parameters:

objectNumber - teh number of teh ndoe to check

operation - a valid operation, i.e. maywrite or maydelete

Throws:

WizardException - if the object cannot be retrieved

mayEditNode

protected boolean mayEditNode(java.lang.String objectNumber)
                       throws WizardException

Returns true if the node with the specified objectnumber can be edited

Parameters:

objectNumber - number of the object to check

Throws:

WizardException - if the object cannot be retrieved

mayDeleteNode

protected boolean mayDeleteNode(java.lang.String objectNumber)
                         throws WizardException

Returns true if the node with the specified objectnumber can be deleted

Parameters:

objectNumber - number of the object to check

Throws:

WizardException - if the object cannot be retrieved

getStartWizardCommand

public WizardCommand getStartWizardCommand()

Returns the subwizard start command

storeConfigurationAttributes

protected void storeConfigurationAttributes(Config.WizardConfig wizardConfig)

Stores configuration variables as attributes in the variabless set.

Parameters:

wizardConfig - the config with the parameters

loadWizard

protected void loadWizard(Config.WizardConfig wizardConfig)
                   throws WizardException

Loads the wizard schema, and a work document, and fills it with initial data.

Parameters:

wizardConfig - the class containing the configuration parameters (i.e. wizard name and objectnumber)

processRequest

public void processRequest(javax.servlet.ServletRequest req)
                    throws WizardException

Processes an incoming request (usually passed on by a jsp code). First, all given values are stored in the current datatree, Second, all given commands are processed sequentially.

Parameters:

req - the ServletRequest contains the name-value pairs received through the http connection

writeHtmlForm

public void writeHtmlForm(java.io.Writer out,
                          java.lang.String instanceName)
                   throws WizardException,
                          javax.xml.transform.TransformerException

Constructs and writes final form-html to the given out writer. You can specify an instancename, so that the wizard is able to start another wizard in the same session. The jsp pages and in the html the instancenames are used to keep track of one and another.

Parameters:

out - The writer where the output (html) should be written to.

instancename - name of the current instance

determineNextForm

public java.lang.String determineNextForm(java.lang.String direction)

This method is used to determine what form is the sequential next, previous, first etc. You can use the parameter to indicate what you want to know:

Parameters:

direction - indicates what you wanna know. Possibilities: - first (default) - last - previous - next

createPreHtml

public org.w3c.dom.Document createPreHtml(java.lang.String instanceName)
                                   throws WizardException

This method generates the pre-html. See the full-spec method for more details.

See Also:

createPreHtml(java.lang.String)

createPreHtml

public org.w3c.dom.Document createPreHtml(org.w3c.dom.Node wizardSchema,
                                          java.lang.String formid,
                                          org.w3c.dom.Node data,
                                          java.lang.String instanceName)
                                   throws WizardException

This method generated the pre-html. Pre-html is a temporarily datatree (xml of course) which is used to generate the final html from. Is uses the wizardschema, the current formid, the current datatree and the instancename to generate the pre-html. Mainly, the pre-html contains all data needed to make a nice htmlform. The XSL's use the pre-html to generate html (thats why pre-html)

Parameters:

wizardSchema - the main node of the schema to be used. Includes should already be resolved.

formid - The id of the current form

data - The main node of the data tree to be used

instancename - The instancename of this wizard

createPreHtmlForm

public void createPreHtmlForm(org.w3c.dom.Node form,
                              org.w3c.dom.Node formdef,
                              org.w3c.dom.Node data)
                       throws WizardException

This method is used by the #createPreHtml method to generate a pre-html form.

Parameters:

form - The node of the pre-html form which is to be generated

formdef - the node of the wizardschema form definition

data - Points to the datacontext node which should be used for this form.

processCommand

public void processCommand(WizardCommand cmd)
                    throws WizardException

This method is usually called by #processCommands and processes one command. Possible wizard commands are:

• delete-item
• update-item
• add-item
• move-up
• move-down
• start-wizard
• goto-form
• cancel
• commit

Parameters:

cmd - The command to be processed

setBinary

public void setBinary(java.lang.String did,
                      byte[] data,
                      java.lang.String name,
                      java.lang.String path)

With this method you can store a binary in the wizard.

Parameters:

did - This is the dataid what points to in what field the binary should be stored, once commited.

data - This is a bytearray with the data to be stored.

name - This is the name which will be used to show what file is uploaded.

path - The (local) path of the file placed.

getBinary

public byte[] getBinary(java.lang.String did)

This method allows you to retrieve the data of a temporarily stored binary.

Parameters:

did - The dataid of the binary you want.

Returns:

the binary data, if found.

getBinaryName

public java.lang.String getBinaryName(java.lang.String did)

With this method you can retrieve the binaryname of a placed binary.

Parameters:

did - The dataid of the binary you want.

Returns:

The name as set when #setBinary was used.

getBinaryPath

public java.lang.String getBinaryPath(java.lang.String did)

With this method you can retrieve the binarypath of a placed binary.

Parameters:

did - The dataid of the binary you want.

Returns:

The path as set when #setBinary was used.

addBinaryData

public void addBinaryData(org.w3c.dom.Node fieldnode)

This method stores binary data in the data, so that the information can be used by the html. This method is called from the form creating code.

Parameters:

fieldnode - the fieldnode where the binary data information should be stored.

mergeConstraints

public void mergeConstraints(org.w3c.dom.Node fieldDef,
                             org.w3c.dom.Node fieldNode)

This method is used to merge MMBase specific constraints with the values placed in the Wizard definition. For now, it checks requiredness and datatypes. It connects to the Dove, gets the constraints (from cache or not) and merges the values.

Parameters:

fieldDef - the fielddefinition as placed in the wizardschema (==definition)

fieldNode - The fieldnode points to the datanode. (This is needed to find out what datatype this field is about).

getConstraints

public org.w3c.dom.Node getConstraints(java.lang.String objecttype)

This method gets the MMBase constraints.

Parameters:

objecttype - The name of the object, eg. images, jumpers, urls, news

getConstraints

public org.w3c.dom.Node getConstraints(java.lang.String objecttype,
                                       java.lang.String fieldname)

This method gets the MMBase constraints. It also handles the internal constraints cache.

Parameters:

objecttype - The name of the object, eg. images, jumpers, urls, news

fieldname - The name of the field, eg. title, body, start