Schema webcockpit.xsd
Top Level Diagram

schema location:  http://webcockpit.sf.net/webcockpit.xsd
 
Elements  Simple types 
webcockpit  chartBindTypeEnum 
chartTypeEnum 
compassDirectionsEnum 
orientationEnum 
queryTypeEnum 
tableBindTypeEnum 


element webcockpit
diagram
annotation
documentation 
A Webcockpit configuration.

element webcockpit/context
diagram
attributes
Name  Type  Use  Default  Fixed  Annotation
displayname  xs:stringrequired      
documentation 
Descriptive text naming the Web Application.
path  xs:stringrequired      
documentation 
Root of the Web Application is found at http://$host:$port/$path.
version  xs:stringoptional  5.5.X    
annotation
documentation 
The web application context data. Output to META-INF/context.xml for Tomcat.

element webcockpit/context/datasource
diagram
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:stringrequired      
documentation 
The name under which the datasource is found in JNDI.
description  xs:stringrequired      
documentation 
Descriptive text relating to the JNDI datasource.
annotation
documentation 
A JNDI datasource specification.

element webcockpit/context/datasource/parameter
diagram
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:stringrequired      
documentation 
Typical parameter names for JDBC datasources include:
url
username
password
driverClassName
maxIdle
maxActive
maxWait
value  xs:stringrequired      
documentation 
Value corresponding to the parameter name.
annotation
documentation 
Individual name, value parameters.

element webcockpit/context/web-inf-addon
diagram
type xs:string
annotation
documentation 
use CDATA to add content to the web.xml, i.e. security context setting.

element webcockpit/context/context-addon
diagram
type xs:string
annotation
documentation 
use CDATA to add content to the context.xml, i.e. reource links and realms

element webcockpit/query
diagram
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:stringrequired      
documentation 
Unique name of the query. Referenced as a data producer by charts and tables.
datasourceid  xs:stringoptional      
documentation 
Optional if there is only one datasource defined in the context.
Must correspond to a datasource id defined in the webcockpit context.
type  queryTypeEnumrequired      
documentation 
The query types 'category', 'pie', 'timeseries' and 'xy' can be used by charts and tables.
Check the chart type to determine which query type is required.
The 'table' query type is only used by tables.
annotation
documentation 
Sql queries are globally known in webcockpit and used by page items.

element webcockpit/query/sql
diagram
type xs:string
annotation
documentation 
Sql containing '?' as a placeholder for bind variables.

element webcockpit/query/bindvar
diagram
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:stringrequired      
documentation 
The unique name of the bind variable.
default  xs:stringoptional      
documentation 
The default value of a bind variable, if none is provided at runtime via page request parameters.
annotation
documentation 
Bind variable values are determined by item links, and are bound into the sql at execution time.

element webcockpit/chartlookandfeel
diagram
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:stringrequired      
documentation 
The name of the look and feel referenced by charts
annotation
documentation 
A named chart coloring scheme which can be referenced by charts to determine the colors and fonts of chart properties.

element webcockpit/chartlookandfeel/color
diagram
type extension of xs:string
attributes
Name  Type  Use  Default  Fixed  Annotation
usage  required      
documentation 
The chart property to which the color applies.
series  xs:nonNegativeIntegeroptional      
documentation 
For usage = series, the series specifies the number of the series ( 0 .. max )
linestyle  optional      
documentation 
For chart properties which refer to lines, this defines the line style. Default for axiscrosshair and gridline is dotted. Default for all other usages is plain.
linewidth  xs:floatoptional  1.0    
documentation 
For chart properties relating to lines, this specifies the line width. Default 1.0.
annotation
documentation 
The color for the series number, i.e. #000000 for black, #FFFFFF for white

element webcockpit/chartlookandfeel/font
diagram
type extension of xs:string
attributes
Name  Type  Use  Default  Fixed  Annotation
usage  required      
documentation 
The chart property to which the font setting applies.
bold  xs:booleanoptional  false    
documentation 
Whether the font is bold or not.
italic  xs:booleanoptional  false    
documentation 
Whether the font is italic or not.
size  xs:positiveIntegeroptional  10    
documentation 
Font size in points.
annotation
documentation 
Font description for chart text. The font name is the element text, i.e. Arial, Verdana, Courier New etc.

element webcockpit/page
diagram
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:stringrequired      
documentation 
The unique name of the webcockpit page.
The id becomes the pagename id.jsp in the web application.
Referenced by links in other pages.
template  xs:stringoptional  default.html    
documentation 
The HTML template filename which is used to mix with generated JSP to become the web application JSP page.
annotation
documentation 
A webcockpit page contains any number of items and is linked to a HTML template

element webcockpit/page/item
diagram
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:stringrequired      
documentation 
Name of the item within a page.
documentation 
Unique over the page, so generic templates can be used.
queryid  xs:stringrequired      
documentation 
The id of the query which defines the Sql which is executed for this item.
annotation
documentation 
An item is a chart and/or a table which itself can link to other pages.

element webcockpit/page/item/chart
diagram
attributes
Name  Type  Use  Default  Fixed  Annotation
type  chartTypeEnumrequired      
documentation 
The type of chart. The type must correspond to its Sql query type.
title  xs:stringoptional      
documentation 
Title of the chart which is displayed on the chart panel above the plot pane. 
xaxislabel  xs:stringoptional      
documentation 
Title of the chart's x-axis. This attributes is ignored if the type attribute of the parent chart tag is one of pie3d or pie.
yaxislabel  xs:stringoptional      
documentation 
Title of the chart's y-axis. This attributes is ignored if the type attribute of the parent chart tag is one of pie3d or pie.
background  xs:stringoptional      
documentation 
Background image of the chart panel. 
The value of this attribute is the filename of a graphics file relative to the web application's root directory (e.g. /WEB-INF/img/bg.jpg). 
The image must be loadable by the default java.awt.Toolkit of the servlet container's JVM. 
backgroundimagealpha  xs:floatoptional  1.0    
documentation 
Chart's backgound alpha blending value as a float. Value ranges from 0.0 to 1.0. 0.0 /chart[backgroundimagealpha] 
antialias  xs:booleanoptional  true    
documentation 
Antialiased rendering of the chart.
showxaxisgridlines  xs:booleanoptional  true    
documentation 
whether to show x axis gridlines
showyaxisgridlines  xs:booleanoptional  true    
documentation 
whether to show y axis gridlines
showxaxiscrosshair  xs:booleanoptional  true    
documentation 
whether to show the x axis's crosshair, for xy charts only
showyaxiscrosshair  xs:booleanoptional  true    
documentation 
whether to show the y axis's crosshair, for xy charts only
showlegend  xs:booleanoptional  true    
documentation 
Boolean value to switch on or off the legend display inside of this panel. 
legendanchor  compassDirectionsEnumoptional  south    
documentation 
Sets the anchor of the legend inside of the panel. 
Ignored if showlegned is 'false'.
lookandfeelid  xs:stringoptional      
documentation 
the id attribute value of a chartlookandfeel element in the webcockpit configuration. If there is only one chartlookandfeel defined, then this chartlookandfeels id is taken as default. This reduces the configuration for each chart in a configuration file, if there is a unique look and feel.
postprocessorbeanid  xs:stringoptional      
documentation 
The id of a JSP bean implementing the Cewolf ChartPostProcessor interface which is availible in the page context. This can be used to plug-in a customized chart postprocessor to modify the chart's properties.
resultchangerclassname  xs:stringoptional  org.webcockpit.beans.DefaultDatasetChanger    
documentation 
Classname of a JSP Bean which can modify the JSTL ResultSet for the chart. Can be used to parse XML data from CLOB fields or re-arrange columns etc.
xaxislabelangle  optional      
documentation 
angle ( in terms of compas directions ) of the xaxis label. Angle 'S' or 'N' to get the labels vertical, angle 'E' to get the labels horizontal. 'E' is the default for horizontal charts, 'S' is the default for vertical charts.
annotation
documentation 
A Cewolf specification of a JFreeChart extended with item linking.
Descriptions copied from http://cewolf.sourceforge.net/

element webcockpit/page/item/chart/colorpaint
diagram
attributes
Name  Type  Use  Default  Fixed  Annotation
color  xs:stringoptional  #000000    
documentation 
The color to be used to fill the parent tag's area. 
The color definition is compatible with the HTML one. E.g. black is '#000000' and red is '#FF0000'. 
However it is possible to append two hex numbers for the alpha channel. 
Thus '#FF000080' is red with alpha blending of 50%.
annotation
documentation 
Fills the chart area with a fixed color.

element webcockpit/page/item/chart/texturepaint
diagram
attributes
Name  Type  Use  Default  Fixed  Annotation
image  xs:stringrequired      
documentation 
Image fo the texture. 
The value of this attribute is the filename of a graphics file relative to the web application's root directory (e.g. /WEB-INF/img/bg.jpg). 
The image must be loadable by the default java.awt.Toolkit of the servlet container's JVM.
width  xs:integeroptional  100    
documentation 
The width of the texture.
height  xs:integeroptional  100    
documentation 
The height of the texture.
annotation
documentation 
The texturepaint tag provides a way to fill the chart with a texture that is specified as an image.
The texture is anchored to the upper left corner of the chart.

element webcockpit/page/item/chart/gradientpaint
diagram
attributes
Name  Type  Use  Default  Fixed  Annotation
cyclic  xs:booleanoptional  false    
documentation 
Does the gradient cycle repeatedly between the two colors C1 and C2?
x1  xs:integeroptional  0    
documentation 
The x coordinate of the point P1
y1  xs:integeroptional  0    
documentation 
The y coordinate of the point P1
color1  xs:stringoptional  #000000    
documentation 
Color C1
x2  xs:integeroptional  100    
documentation 
The x coordinate of the point P2
y2  xs:integeroptional  100    
documentation 
The y coordinate of the point P2
color2  xs:stringoptional  #FFFFFF    
documentation 
Color C2
annotation
documentation 
The gradientpaint tag provides a way to fill a shape with a linear color gradient pattern.
If Point P1 with Color C1 and Point P2 with Color C2 are specified in user space, the Color on the P1, P2 connecting line is proportionally changed from C1 to C2. 
Any point P not on the extended P1, P2 connecting line has the color of the point P' that is the perpendicular projection of P on the extended P1, P2 connecting line. 
Points on the extended line outside of the P1, P2 segment can be colored in one of two ways.
If the gradient is acyclic then points on the P1 side of the segment have the constant Color C1 while points on the P2 side have the constant Color C2.

element webcockpit/page/item/chart/img
diagram
attributes
Name  Type  Use  Default  Fixed  Annotation
width  xs:integerrequired      
documentation 
Width of the rendered chart image in pixel.
height  xs:integerrequired      
documentation 
Height of the rendered chart image in pixel.
mime  xs:stringoptional  image/png    
documentation 
The MIME type of the image. Currently image/png (default) and image/svg are supported. image/png.
alt  xs:stringoptional      
documentation 
Alternative text for browsers  which have images disabled.
hspace  xs:stringoptional      
vspace  xs:stringoptional      
align  xs:stringoptional      
border  xs:stringoptional      
ismap  xs:stringoptional      
longdesc  xs:stringoptional      
usemap  xs:stringoptional      
documentation 
Setting usemap explicitly will override the webcockpit default linking.
Can use a non existent map name, i.e. '#none' to disable default linking.
dir  xs:stringoptional      
lang  xs:stringoptional      
onclick  xs:stringoptional      
ondbclick  xs:stringoptional      
onkeydown  xs:stringoptional      
onkeypress  xs:stringoptional      
onkeyup  xs:stringoptional      
onmouseover  xs:stringoptional      
onmousedown  xs:stringoptional      
onmouseout  xs:stringoptional      
onmousemove  xs:stringoptional      
onmouseup  xs:stringoptional      
style  xs:stringoptional      
htmltitle  xs:stringoptional      
documentation 
Tooltip text which pops up when mouse hovers over parts of image which are not graph bars or points which have their own tooltips.
annotation
documentation 
HTML img attributes.

element webcockpit/page/item/chart/link
diagram
attributes
Name  Type  Use  Default  Fixed  Annotation
refpageid  xs:stringoptional      
documentation 
The id of another Webcockpit page in this configuration file.
If set, refpage is ignored.
refpage  xs:stringoptional      
documentation 
URI of a page not defined in this configuration.
Absolute or relative to the Web Application's path.
annotation
documentation 
Links the chart's category, series and values to the page specified here. 
documentation 
The category, series and values can be individually bound with the nested bind elements.

element webcockpit/page/item/chart/link/bind
diagram
type extension of xs:string
attributes
Name  Type  Use  Default  Fixed  Annotation
type  chartBindTypeEnumrequired      
bindvar  xs:stringrequired      
documentation 
Name of a Sql queries bindvar in the page being linked to.
annotation
documentation 
Determines the name of the sql bindvar to use for passing chart data in the link.

element webcockpit/page/item/table
diagram
attributes
Name  Type  Use  Default  Fixed  Annotation
maxrows  xs:integeroptional  1000    
documentation 
Up to maxrows rows will be displayed in the HTML table.
With vertical orientation, this implies 'columns'.
showheadings  xs:booleanoptional  true    
cssclass  xs:stringoptional  wcptable    
documentation 
if omittable is false, this becomes the HTML table's class
evenrowcssclass  xs:stringoptional  wcpevenrow    
documentation 
the CSS class applied to each even row. Use to create alternating colored rows with the oddrowcssclass style and a CSS stylesheet.
oddrowcssclass  xs:stringoptional  wcpoddrow    
documentation 
the CSS class applied to each odd row. Use to create alternating colored rows with the evenrowcssclass style and a CSS stylesheet.
resultchangerclassname  xs:stringoptional  org.webcockpit.beans.DefaultDatasetChanger    
documentation 
Classname of a JSP Bean which can modify the JSTL ResultSet for the chart. Can be used to parse XML data from CLOB fields or re-arrange columns etc.
decoratorclassname  xs:stringoptional      
documentation 
displaytag table decorator attribute
export  xs:booleanoptional  true    
documentation 
displaytag table export attribute. Provide links to export CSV, XML and Excel format.
pagesize  xs:integeroptional  0    
documentation 
displaytag table pagesize attribute. 0 means no paging.
pagingfirstlast  xs:booleanoptional  true    
documentation 
displaytag table property paging.banner.include_first_last . Determines if the paging banner shows the first last page navigation.
pagingplacement  optional  top    
documentation 
displaytag table property - paging.banner.placement. Determines if the paging banner is on top or on the bottom of the table.
sortbehaviour  optional  list    
documentation 
displaytag table sort attribute. Determines whether to sort the entire list or just the page when sorting by column.
defaultorder  optional  ascending    
documentation 
displaytag table defaultorder attribute - whether to sort the default sort column ascending or descending.
defaultsort  xs:integeroptional  1    
documentation 
displaytag table defaultsort attribute. determines which column to sort by as default.
annotation
documentation 
A HTML table based on a sql queries result set. each column can have its own link specification.

element webcockpit/page/item/table/column
diagram
attributes
Name  Type  Use  Default  Fixed  Annotation
alias  xs:stringoptional      
documentation 
Column name, as defined in the SQL query linked to the table, which will link according to the nested bind elements. Either alias or columnnum is required.
columnnum  xs:integeroptional      
documentation 
column number 1...N in the sql query defined for feeding the table. Either alias or columnnum is required.
title  xs:stringoptional      
documentation 
displaytag column attribute title. Defaults to the alias if not provided.
autolink  xs:booleanoptional  true    
documentation 
displaytag column autolink attribute. Any url's or email addresses in the column text will be hyperlinked.
cssclass  xs:stringoptional      
documentation 
displaytag column class attribute. HTML class associated with the column.
headercssclass  xs:stringoptional      
documentation 
displaytag column attribute headerclass. Determines the css class of the column header.
maxlength  xs:integeroptional  0    
documentation 
displaytag column attribute maxlength. Determines the maximum number of characters in the column before truncation. 0 unlimited.
maxwords  xs:integeroptional  0    
documentation 
displaytag column attribute maxwords. Determines the maximum number of words in the column before truncation. 0 unlimited.
media  optional  all    
documentation 
displaytag column attribute media. Use this attribute to keep a column from being output during an export. The column will only render for the named media type(s) - it won't be added to the table if the current request media is not supported. Can be any space separated combination of 'html', 'csv', 'xml', 'all', or 'excel'. Defaults to 'all'.
sortable  xs:booleanoptional  true    
documentation 
displaytag column attribute sortable. Set to 'true' to make the column sortable.
nulls  xs:booleanoptional  false    
documentation 
displaytag column attribute nulls. By default, null values don't appear in the list. By setting 'nulls' to 'true', then null values will appear as "null" in the list (mostly useful for debugging). Defaults to 'false'.
group  xs:integeroptional  -1    
documentation 
displaytag column attribute group. The grouping level (starting at 1 and incrementing) of this column (indicates if successive contain the same values, then they should not be displayed). The level indicates that if a lower level no longer matches, then the matching for this higher level should start over as well. If this attribute is 0, then no grouping is performed.
decorator  xs:stringoptional      
documentation 
displaytag column attribute decorator. The fully qualified class name of a class that should be used to "decorate" the underlying object being displayed. The class should implement org.displaytag.decorator.ColumnDecorator. If a decorator is specified for the entire table, then this decorator will decorate that decorator.
annotation
documentation 
Column instructions provide a means of modifying the table representation for any columns.

element webcockpit/page/item/table/column/link
diagram
attributes
Name  Type  Use  Default  Fixed  Annotation
refpageid  xs:stringoptional      
documentation 
The id of another Webcockpit page in this configuration file.
If set, refpage is ignored.
refpage  xs:stringoptional      
documentation 
URI of a page not defined in this configuration.
Absolute or relative to the Web Application's path.
annotation
documentation 
Links the chart's category, series and values to the page specified here. 
documentation 
The category, series and values can be individually bound with the nested bind elements.

element webcockpit/page/item/table/column/link/bind
diagram
type extension of xs:string
attributes
Name  Type  Use  Default  Fixed  Annotation
type  tableBindTypeEnumrequired      
bindvar  xs:stringrequired      
documentation 
Name of a Sql queries bindvar in the page being linked to.
annotation
documentation 
For column type, the bind element's text defines the column name who's value is passed at runtime. 
For constant types, the bind element's value is passed directly to the link's target page. For bindvar type, the bind element's value is the name of a Sql bindvar used in this item's sql query.

simpleType chartBindTypeEnum
type restriction of xs:string
used by
attribute webcockpit/page/item/chart/link/bind/@type
facets
enumeration category
enumeration series
enumeration value
enumeration x
enumeration y
enumeration constant
enumeration bindvar
enumeration low
enumeration high
enumeration open
enumeration close
enumeration signaltype
enumeration windforce
enumeration winddirection
annotation
documentation 
Link bind types for charts.

simpleType chartTypeEnum
type restriction of xs:string
used by
attribute webcockpit/page/item/chart/@type
facets
enumeration area
enumeration areaxy
enumeration horizontalBar
enumeration horizontalBar3D
enumeration line
enumeration pie
enumeration pie3d
enumeration scatter
enumeration stackedHorizontalBar
enumeration stackedVerticalBar
enumeration stackedVerticalBar3D
enumeration timeseries
enumeration verticalBar
enumeration verticalBar3D
enumeration xy
enumeration candlestick
enumeration highlow
enumeration gantt
enumeration wind
enumeration signal
enumeration verticalxybar
annotation
documentation 
JFreeChart Chart Types

simpleType compassDirectionsEnum
type restriction of xs:string
used by
attribute webcockpit/page/item/chart/@legendanchor
facets
enumeration south
enumeration north
enumeration east
enumeration west
annotation
documentation 
Compass Directions

simpleType orientationEnum
type restriction of xs:string
facets
enumeration horizontal
enumeration vertical
annotation
documentation 
Orientations

simpleType queryTypeEnum
type restriction of xs:string
used by
attribute webcockpit/query/@type
facets
enumeration pie
enumeration category
enumeration xy
enumeration timeseries
enumeration table
enumeration highlow
enumeration signal
enumeration wind
enumeration verticalxybar
enumeration gantt
annotation
documentation 
Types of Query relating to Chart Types.RowFormats:
pie - category, value
category - series, category, value
timeseries - series, date-x, y
xy - series, x, y
highlow - series, date-x, low-value, high-value, open-value, close-value
signal - series, date-x, y, type ( 1 enter long, -1 enter short, 2 exit long , -2 exit short)
wind - series, date-x, direction (0..12), force (0..12)
bar - series, date-start-x, date-end-x, start-y, end-y
table - no specific row format.

simpleType tableBindTypeEnum
type restriction of xs:string
used by
attribute webcockpit/page/item/table/column/link/bind/@type
facets
enumeration column
enumeration constant
enumeration bindvar
annotation
documentation 
Link bind types for tables.


SourceForge.net Logo