org.dlese.dpc.schemedit.autoform

Class EditorViewRecord

java.lang.Object

org.dlese.dpc.schemedit.autoform.AutoForm

org.dlese.dpc.schemedit.autoform.DcsViewRecord

org.dlese.dpc.schemedit.autoform.EditorViewRecord

public class EditorViewRecord
extends DcsViewRecord

Supports creation of jsp to view (as opposed to edit) an entire MetaDataRecord within the metadata editor. Jsp is constructed by the EditorViewerRenderer.

Version:

$Id: EditorViewRecord.java,v 1.12 2009/07/07 02:52:53 ostwald Exp $

Author:

ostwald

Field Summary

Fields inherited from class org.dlese.dpc.schemedit.autoform.AutoForm

df, formBeanName, framework, instanceDocument, schemaFile, sh, writer

Constructor Summary

Constructors

Constructor and Description
EditorViewRecord(MetaDataFramework framework) Constructor for the EditorViewRecord object
EditorViewRecord(java.lang.String xmlFormat) Constructor for the Stand-alone DcsViewRecord object, meaning it is created from command line rather than via schemedit.

Method Summary

Modifier and Type	Method and Description
protected java.io.File	getBatchJspDest(java.lang.String pageName) Contruct a path for the component jsp pages
protected java.lang.String	getComponentJspHeader() JSP code to insert at the top of component jsp files.
protected java.io.File	getJspDest(java.lang.String unused) Contruct a path for the single jsp page, in the case of single-page jsp, or the page that integrates the component jsp pages, in the case of batch-rendered frameworks.
protected java.lang.String	getMasterComponentPath(java.lang.String pageName)
protected java.lang.String	getMasterJspHeader() JSP code to insert at the top of master jsp files.
protected java.lang.String	getRendererClassName() Gets the rendererClassName attribute of the EditorViewRecord object
static void	main(java.lang.String[] args) The main program for the EditorViewRecord class, to be invoked from the command line for debugging purposes.

Methods inherited from class org.dlese.dpc.schemedit.autoform.DcsViewRecord

batchRenderAndWrite, renderAndWrite, setLogging

Methods inherited from class org.dlese.dpc.schemedit.autoform.AutoForm

elementToJsp, prtlnErr, render, render, renderAndWrite, renderAndWrite, setVerbose, writeJsp

Methods inherited from class java.lang.Object

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

Constructor Detail

EditorViewRecord

public EditorViewRecord(MetaDataFramework framework)

Constructor for the EditorViewRecord object

Parameters:

framework - Description of the Parameter

EditorViewRecord

public EditorViewRecord(java.lang.String xmlFormat)
                 throws java.lang.Exception,
                        SchemaHelperException

Constructor for the Stand-alone DcsViewRecord object, meaning it is created from command line rather than via schemedit.

Parameters:

xmlFormat - Description of the Parameter

Throws:

SchemaHelperException - Description of the Exception

java.lang.Exception - NOT YET DOCUMENTED

Method Detail

main

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

The main program for the EditorViewRecord class, to be invoked from the command line for debugging purposes.

Parameters:

args - The command line arguments

Throws:

java.lang.Exception

getRendererClassName

protected java.lang.String getRendererClassName()

Gets the rendererClassName attribute of the EditorViewRecord object

Overrides:

getRendererClassName in class DcsViewRecord

Returns:

The rendererClassName value

getJspDest

protected java.io.File getJspDest(java.lang.String unused)

Contruct a path for the single jsp page, in the case of single-page jsp, or the page that integrates the component jsp pages, in the case of batch-rendered frameworks.

Overrides:

getJspDest in class DcsViewRecord

Parameters:

unused - NOT YET DOCUMENTED

Returns:

The jspDest value

getBatchJspDest

protected java.io.File getBatchJspDest(java.lang.String pageName)
                                throws java.lang.Exception

Contruct a path for the component jsp pages

Overrides:

getBatchJspDest in class DcsViewRecord

Parameters:

pageName - NOT YET DOCUMENTED

Returns:

The batchJspDest value

Throws:

java.lang.Exception - NOT YET DOCUMENTED

getMasterJspHeader

protected java.lang.String getMasterJspHeader()

Description copied from class: AutoForm

JSP code to insert at the top of master jsp files.

Overrides:

getMasterJspHeader in class DcsViewRecord

Returns:

The masterJspHeader value

getComponentJspHeader

protected java.lang.String getComponentJspHeader()

Description copied from class: AutoForm

JSP code to insert at the top of component jsp files. In the case of AutoForm, where the components are on separate JSP pages, the component and master headers are the same. In subclasses, the component JSP pages maybe included (via jsp:include) in the master, and therefore they may require a different header.

Overrides:

getComponentJspHeader in class AutoForm

Returns:

The componentJspHeader value

getMasterComponentPath

protected java.lang.String getMasterComponentPath(java.lang.String pageName)

Overrides:

getMasterComponentPath in class DcsViewRecord