jacquard 1.12.0 by The Web Engineering Factory and Toolworks

Serialized Form


Package uk.co.weft.alert

Class uk.co.weft.alert.AlertingException extends java.lang.Exception implements Serializable


Package uk.co.weft.configurator

Class uk.co.weft.configurator.BasicConfigurator extends Form implements Serializable

Serialized Fields

intro

Element intro
An XML element whose value should be printed out as my introductory material; may include HTML markup.


payloadName

java.lang.String payloadName
name of my payload


payloadPath

java.lang.String payloadPath
location of my payload. Full or relative pathname or URL of the war archive which is my payload


stagePath

java.lang.String stagePath
location of my staging area. Full or relative pathname to a directory which the servlet has permission to write to and read from


stage

java.io.File stage
where my staging area acutally is


files

java.util.Map files
a vector of relative names of files within the payload which must be modified


payload

java.net.URL payload
where my payload actually is


configuredWidgetSet

WidgetSet configuredWidgetSet
the widgetset to switch to when I've succeeded in configuring


tidyStage

boolean tidyStage
whether or not to clean up the staging area after building a delivery package. Default is do. Note that the delivery package itself is not removed; tidying these up should be done (later) by a separate process.


gensymSeed

int gensymSeed
a number to help me generate unique numbers for subdirectories of my staging area

Class uk.co.weft.configurator.BasicConfigurator.ConfiguredWidgetSet extends WidgetSet implements Serializable

Class uk.co.weft.configurator.ConfigurationException extends DataFormatException implements Serializable

Class uk.co.weft.configurator.DatabaseAwareConfigurator extends BasicConfigurator implements Serializable

Class uk.co.weft.configurator.FirstTime extends AuthenticatedForm implements Serializable

Serialized Fields

sqlSource

java.lang.String sqlSource
Deprecated. 
where I find my SQL source


Package uk.co.weft.dbutil

Class uk.co.weft.dbutil.Calendar extends java.util.GregorianCalendar implements Serializable

Class uk.co.weft.dbutil.ConnectionPoolException extends DataStoreException implements Serializable

Class uk.co.weft.dbutil.Context extends java.util.Hashtable implements Serializable

Serialized Fields

watchKeys

java.util.Hashtable watchKeys
it's useful to be able to watch when a particular value changes in a context, but having an extra hash table as a bag on the side of every context would be a horrible garbage collection overhead so we will create one only as necessary.

See Also:
Context.watch(String)

knownkeys

java.util.Vector knownkeys
my keys. The order of the keys in a hashtable must come from something rational but I cannot work out what it is. It isn't serial and it doesn't follow any obvious collating sequence (unless it's collated by hash value, which would have some logic). There's merit in Contexts returning their keys in serial order, since that will mean that e.g. database fields get returned in the order in which they were asked for

Class uk.co.weft.dbutil.Contexts extends java.util.Vector implements Serializable

Serialized Fields

keyName

java.lang.String keyName

Class uk.co.weft.dbutil.DataAuthException extends DataStoreException implements Serializable

Class uk.co.weft.dbutil.DataFormatException extends DataStoreException implements Serializable

Class uk.co.weft.dbutil.DataStoreException extends java.lang.Exception implements Serializable

Class uk.co.weft.dbutil.ISO8601Calendar extends java.util.GregorianCalendar implements Serializable

Class uk.co.weft.dbutil.RSContexts extends Contexts implements Serializable


Package uk.co.weft.domutil

Class uk.co.weft.domutil.CachedPage extends TransformPage implements Serializable

Serialized Fields

locks

java.util.Hashtable locks
Holds write locks on the cache when writing to it so as to prevent a pull happening when a write is in progress


cachePath

java.lang.String cachePath
where my cache is in the file system; default to /tmp


updatingPageURL

java.net.URL updatingPageURL
the url of our when-updating page


bufferBlockSize

int bufferBlockSize
how large a buffer I use for schlurping files out to the net


ttl

int ttl
how long things live in my cache; default is twenty minutes


nonseparator

char nonseparator
A character which is not the file separator character on this OS

Class uk.co.weft.domutil.ClientsideXslSensitivePage extends CachedPage implements Serializable

Class uk.co.weft.domutil.DocPage extends WithExceptionHandlerServlet implements Serializable

Serialized Fields

xslDocument

Document xslDocument
the XSL stylesheet as a document object


caxton

Printer caxton
the DOM printer I'm going to use


entitiesFileName

java.lang.String entitiesFileName
the name of my entities properties file, if any


xslStylesheetName

java.lang.String xslStylesheetName
the name of the XSL stylesheet I am to use, if any


transformerFactory

TransformerFactory transformerFactory
A factory class for XSL transformers; this is Xalan 2


generators

java.util.Vector generators
my document generators


processClientSide

boolean processClientSide
whether I seek to offload XSL processing to client side

Class uk.co.weft.domutil.GenerationException extends java.lang.Exception implements Serializable

Serialized Fields

cause

java.lang.Exception cause

Class uk.co.weft.domutil.TransformPage extends DocPage implements Serializable

Serialized Fields

transforms

TransformCache transforms
a lookup table, text-rep-of-URL as key, DocumentImpl as value


allowXSLFromContext

boolean allowXSLFromContext
whether I allow XSL transforms to be specified in the context


Package uk.co.weft.event

Class uk.co.weft.event.DiaryMonth extends AuthenticatedForm implements Serializable

Class uk.co.weft.event.Event extends TableWrapperForm implements Serializable

Class uk.co.weft.event.ICalServlet extends Servlet implements Serializable


Package uk.co.weft.graphic

Class uk.co.weft.graphic.ExampleMappedImageServlet extends Graphic implements Serializable

Class uk.co.weft.graphic.Graphic extends Servlet implements Serializable

Serialized Fields

width

int width
The width of my canvas


height

int height
The height of my canvas


contentType

java.lang.String contentType
my content type


format

java.lang.String format
my graphics format

Class uk.co.weft.graphic.Thumbnail extends Servlet implements Serializable


Package uk.co.weft.htform

Class uk.co.weft.htform.AuthenticatedForm extends Form implements Serializable

Serialized Fields

logoutWidget

ActionWidget logoutWidget
The logout widget, created at instanitation time. To override the default updateWidget, a specialisation must set updateWidget to an instantiation of an ActionWidget before calling super.init()


authenticator

Authenticator authenticator
the authenticator I use to authenticate my users


logoutPrompt

java.lang.String logoutPrompt
prompt strong for my logout widget


onLogoutRedirect

java.lang.String onLogoutRedirect
The URL to redirect to following logout


authentificationWidgets

WidgetSet authentificationWidgets
An alternate set of widgets to be used for authentification


allowLogout

boolean allowLogout
Whether to offer the user a logout button

Class uk.co.weft.htform.AutoForm extends TableWrapperForm implements Serializable

Serialized Fields

id

int id
the number which identifies this servlet in the database


reloadWidgets

boolean reloadWidgets
whether to refresh the widgets from the database each time I'm called

Class uk.co.weft.htform.ChangePasswordForm extends AuthenticatedForm implements Serializable

Serialized Fields

passwordAgent

JDBCUserKluge passwordAgent
the kluge which will do the real work

Class uk.co.weft.htform.CompositeStylesheetSample extends Page implements Serializable

Serialized Fields

query

java.lang.String query
query template to use for querying the database. Must have one '?' as a placeholder for the value of masterkey


masterkey

java.lang.String masterkey
the name of the token in the context which will be bound to the key value

Class uk.co.weft.htform.DataTable extends Servlet implements Serializable

Class uk.co.weft.htform.Form extends Page implements Serializable

Serialized Fields

action

java.lang.String action
the URL to pass collected data to


mandatoryPrompt

java.lang.String mandatoryPrompt
Text to append to widget prompts where widget is mandatory


optionalPrompt

java.lang.String optionalPrompt
Text to append to widget prompts where widget is not mandatory


submitMethod

java.lang.String submitMethod
what method shall I use for submitting my form?

Since:
Jacquard 1.10.8

whingeHeader

java.lang.String whingeHeader
Header text for the list of validation errors if any


auxiliaries

java.util.Vector auxiliaries
My auxiliary tables


widgetSets

java.util.Vector widgetSets
All my widget sets


widgets

WidgetSet widgets
My default widgets


showHeadline

boolean showHeadline
do I show the forms headline? For most things it's a great convenience, for some a nuisance

Class uk.co.weft.htform.InitialisationException extends java.lang.Exception implements Serializable

Class uk.co.weft.htform.List extends AuthenticatedForm implements Serializable

Serialized Fields

formatter

ResultFormatter formatter
my result formatter object


action

java.lang.String action
the action (URL) to invoke to select a record from the results. Should be set up in the init method.


actionField

java.lang.String actionField
the field by which to select a record from the results. Should be set up in the init method.


canAdd

java.lang.String canAdd
the text of a 'add another' link; if set, use action URL; if not set, don't show


formatterName

java.lang.String formatterName
the classname of my result formatter object


linkField

java.lang.String linkField
the field to highlight to allow the user to select a record in the results


listQueryTemplate

java.lang.String listQueryTemplate
a query template to select the records to list. Should be set up in the init method.

See Also:
PreparedStatement

lowerFn

java.lang.String lowerFn
the name of the SQL function which coerces characters to lower case


matchDelimEnd

java.lang.String matchDelimEnd
suffix for substring match


matchDelimStart

java.lang.String matchDelimStart
prefix for substring match


matchOp

java.lang.String matchOp
the SQL operator to use to do matching


orderBy

java.lang.String orderBy
the names I should order the results by


searchField

java.lang.String searchField
the database field in which to search


searchHelp

java.lang.String searchHelp
the help string for the search widget


searchToken

java.lang.String searchToken
the magic token for searching. Should be configurable or come from a properties file for flexibility and i18n reasons


searchPrompt

java.lang.String searchPrompt
the prompt string for the search widget


searchw

Widget searchw
the widget in which search text should be entered, if any


slots

java.lang.String[] slots
an array of the names of values in the context to be pasted into the query. Should be set up in the init method. If there are no slots in the query, should be left null.


clickToOrder

boolean clickToOrder
should those headers be clickable to reorder the result? Normally they should.

Since:
Jacquard 1.9.1

noDefaultList

boolean noDefaultList
should I layout a default list first?


recogniseLinks

boolean recogniseLinks
should I recognise links and format them appropriately? Normally yes


showCanAddBefore

boolean showCanAddBefore
whether to show the cannAdd link before the list, as well as after it; default is we do.


showHeaders

boolean showHeaders
should I show the field names as column headers? Normally yes


showId

boolean showId
should I show the id column? Normally yes


searchSize

int searchSize
the size of the widget


actionLabel

java.lang.String actionLabel
the label for the edit link. Should be set up in the init method.

Class uk.co.weft.htform.Page extends WithExceptionHandlerServlet implements Serializable

Serialized Fields

dynamicFootInclude

java.lang.Boolean dynamicFootInclude
whether the fragment should be refetched at each request (we really don't want to have to do this

Since:
Jacquard 1.9

dynamicHeadInclude

java.lang.Boolean dynamicHeadInclude
whether the fragment should be refetched at each request (we really don't want to have to do this


footInclude

java.lang.String footInclude
an HTML fragment to include at the beginning of the body of each page

Since:
Jacquard 1.9

headInclude

java.lang.String headInclude
an HTML fragment to include at the beginning of the body of each page


imageUrlBase

java.lang.String imageUrlBase
the base URL for utility images I may need

Since:
Jacquard 1.10

title

java.lang.String title
my title.

See Also:
Page.getTitle()

titleMagicToken

java.lang.String titleMagicToken
Deprecated. use TITLEMAGICTOKEN

a magic token to allow my title to be extracted from the context

See Also:
Constant Field Values

layout

Layout layout
My layout engine.

See Also:
Layout

footIncludeURL

java.lang.String footIncludeURL
the URL from which that fragment should be fetched

Since:
Jacquard 1.9

headIncludeURL

java.lang.String headIncludeURL
the URL from which that fragment should be fetched


printStylesheet

java.lang.String printStylesheet
The URL of my print stylsheet


stylesheet

java.lang.String stylesheet
The URI of my stylesheet


doctype

java.lang.String doctype
my document type declaration


tables

boolean tables
whether to use tables in laying me out

Class uk.co.weft.htform.PasswordForm extends AuthenticatedForm implements Serializable

Serialized Fields

goodPasswordPattern

RE goodPasswordPattern
A pattern which matches acceptable passwords

Class uk.co.weft.htform.QueryByExampleList extends List implements Serializable

Serialized Fields

key

java.lang.String key
the name of the keyfield in my data store


store

java.lang.String store
the name of my data store


exact

boolean exact
do I require an exact match?

Class uk.co.weft.htform.Servlet extends MaybeUploadServlet implements Serializable

Serialized Fields

parsePathInfo

Context parsePathInfo
a hashtable of keys I'm prepared to parse out of the path info string


calendar

java.util.GregorianCalendar calendar
handy to have a calendar around to help with manipulating dates


here

java.util.Locale here
where we are operating - defaults to UK english


conf

javax.servlet.ServletConfig conf
My configuration object, passed to me when I was created


contentType

java.lang.String contentType
the MIME type of my content


cookieDomain

java.lang.String cookieDomain
the domain for my cookies


cookiePath

java.lang.String cookiePath
the path for my cookies


dbPassword

java.lang.String dbPassword
and password to connect me to the database, if any


dbUrl

java.lang.String dbUrl
where to find the database: there is no safe default.


dbUsername

java.lang.String dbUsername
the username...


driverName

java.lang.String driverName
the classname of my database driver, if any


identity

java.lang.String identity
my identity


resourceBundleName

java.lang.String resourceBundleName
the name of the resource bundle I will search for resources. By default, 'jacquard'


zone

java.util.TimeZone zone
the timezone in which we are operating -defaults to BST


debug

boolean debug
print additional diagnostics on error


embedded

boolean embedded
whether I am embedded in an existing (e.g. JHTML) page


ready

boolean ready
Flag to say whether second-stage initialisation is complete. Problem is many servlets have initialisation things they can only do when they have a connection, and at init() time they don't have. This is a hook to allow them to do that. You really, really do not want to mess with this.


cookieTTL

int cookieTTL
the default time-to-live of cookies


cookies

java.util.Vector cookies
any cookies I send

Class uk.co.weft.htform.ServletForm extends TableWrapperForm implements Serializable

Class uk.co.weft.htform.TableWrapperForm extends AuthenticatedForm implements Serializable

Serialized Fields

deleteWidget

ActionWidget deleteWidget
The delete widget, created at instantiation time. To override the default updateWidget, a specialisation must set updateWidget to an instantiation of an ActionWidget before calling super.init()


updateWidget

ActionWidget updateWidget
The update widget, created at instantiation time. To override the default updateWidget, a specialisation must set updateWidget to an instantiation of an ActionWidget before calling super.init()


identField

java.lang.String identField
a field in this table with user-identifying information


keyField

java.lang.String keyField
the primary key field in this table


onDropRedirect

java.lang.String onDropRedirect
The URL to redirect to following a successful drop


onStoreRedirect

java.lang.String onStoreRedirect
The URL to redirect to following a successful store


table

java.lang.String table
the table this form populates. Must be established at initialisation time and never changed during the lifetime of the servlet instance.


tableDescriptor

TableDescriptor tableDescriptor
a descriptor for that table


identWidget

Widget identWidget
A hidden widget to pass through my identifier.


maybeDeleteWidgets

WidgetSet maybeDeleteWidgets
An alternate set of widgets to be used for deletion if we use two-stage


allowDelete

boolean allowDelete
Whether the data item I represent can be deleted


confirmBeforeDelete

boolean confirmBeforeDelete
Whether or not to use two-stage 'confirmed' delete


descriptorIsValid

boolean descriptorIsValid
is this information valid?

Class uk.co.weft.htform.WidgetForm extends TableWrapperForm implements Serializable

Serialized Fields

mwws

WidgetForm.MenuWidgetWidgetSet mwws

ltws

WidgetForm.LinkTableWidgetSet ltws

Class uk.co.weft.htform.WidgetSet extends java.util.Vector implements Serializable

Serialized Fields

form

Form form
The form I belong to. May not be needed in the long term but used for now to set up Widget.form


accessKeys

java.util.Hashtable accessKeys
My access keys - the (character of the) single key used to select a widget.


name

java.lang.String name
My name - important!


precedence

int precedence
My precedence - where I sit in the pecking order (scale 1 - 100)

Class uk.co.weft.htform.WithExceptionHandlerServlet extends Servlet implements Serializable

Serialized Fields

whinger

ExceptionHandler whinger
the exception handler to which to pass exceptions


Package uk.co.weft.maybeupload

Class uk.co.weft.maybeupload.DumpServlet extends javax.servlet.http.HttpServlet implements Serializable

Class uk.co.weft.maybeupload.MaybeUploadRequestWrapper extends java.util.Hashtable implements Serializable

Serialized Fields

MFDHEADER

java.lang.String MFDHEADER
the standard identifying header of a multipart request

See Also:
Constant Field Values

maxUpload

int maxUpload
the maximum upload size.


request

javax.servlet.http.HttpServletRequest request
the request I wrap


decoder

MultipartHandler decoder
the handler which decodes my input if I am multipart


isMultipart

boolean isMultipart
whether that request is multipart

Class uk.co.weft.maybeupload.MaybeUploadServlet extends javax.servlet.http.HttpServlet implements Serializable

Serialized Fields

uploadDir

java.io.File uploadDir
the actual upload directory as a file object


uploadDirPath

java.lang.String uploadDirPath
file system local path to where I unpack files I have uploaded


uploadDirURL

java.lang.String uploadDirURL
the path to my upload directory (work directory) within the document root of the web server, if it is within the document root of the web server, else null. For example, if uploadDirPath was "/home/httpd/htdocs/upload", and the document root of the Web server was /home/httpd/htdocs, then it would make sense to have uploadDirURL set to "/upload/"


allowOverwrite

boolean allowOverwrite
whether to allow uploaded files to be overwritten when new files are uploaded; default is we don't


saveUploadedFilesToDisk

boolean saveUploadedFilesToDisk
whether or not to save uploads directly to disk; default is we do


silentlyRename

boolean silentlyRename
whether or not to rename uploaded files to prevent name collisions; default is we do


maxUpload

int maxUpload
the maximum upload size: by default, half a megabyte.

Class uk.co.weft.maybeupload.RequestTooLargeException extends java.io.IOException implements Serializable

Class uk.co.weft.maybeupload.SnoopServlet extends MaybeUploadServlet implements Serializable

Class uk.co.weft.maybeupload.UploadedFile extends java.io.File implements Serializable

Serialized Fields

clientPathname

java.lang.String clientPathname
the path name from which this file is said to have been uploaded


contentType

java.lang.String contentType
the content type which the uploading agent claimed this file to have

Class uk.co.weft.maybeupload.UploadException extends javax.servlet.ServletException implements Serializable


Package uk.co.weft.stylist

Class uk.co.weft.stylist.ChangeStyle extends Form implements Serializable

Class uk.co.weft.stylist.Stylist extends Servlet implements Serializable

Serialized Fields

directory

java.io.File directory
default stylesheet directory


defaultName

java.lang.String defaultName
default stylesheet name


Package uk.co.weft.substitute

Class uk.co.weft.substitute.SubstitutionException extends java.lang.Exception implements Serializable


jacquard 1.12.0 by The Web Engineering Factory and Toolworks