FiForms Report Output Documentation

Table of Contents

top

Schema Document Properties

Target Namespace http://xml.fiforms.org/FiReports/
Version 1.2
Language en
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations have no namespace.
  • By default, local attribute declarations have no namespace.
Schema Composition
  • This schema imports schema(s) from the following namespace(s):
    • http://xml.fiforms.org/FiForms/ (at http://xml.fiforms.org/schema/11/FiForm.xsd)
Documentation This is the XML Schema for FiReport XML Datasets.
More information at: http://xml.fiforms.org/FiForms/.

This Schema is distributed with FiForms, a collection of PHP classes designed to facilitate rapid development of web-database software

Copyright (C) 2003-2007 Daniel McFeeters

This library is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
More information at: http://www.gnu.org/copyleft/lesser.html.

The original author of this library can be contacted at the following address:

Daniel McFeeters

312 Bill Neal Rd.

Whitley City, KY 42653-4209

email:info at fiforms dot net

You can find out more about FiForms Solutions and download the open-source (GPL) collection of FiForms PHP Classes from www.fiforms.org
More information at: http://www.fiforms.org.

Declared Namespaces

Prefix Namespace
Default namespace http://xml.fiforms.org/FiReports/
xml http://www.w3.org/XML/1998/namespace
fiforms http://xml.fiforms.org/FiForms/
xs http://www.w3.org/2001/XMLSchema
Schema Component Representation
<xs:schema xml:lang="en" targetNamespace="http://xml.fiforms.org/FiReports/" version="1.2">
<xs:import namespace="http://xml.fiforms.org/FiForms/" schemaLocation="http://xml.fiforms.org/schema/11/FiForm.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: dataset

Name dataset
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Each result set coming from an sql query is contained in a dataset
XML Instance Representation
<dataset
name="anySimpleType [0..1]">
<f> ... </f> [0..unlimited]
<row> ... </row> [0..unlimited]
<dataset> ... </dataset> [0..unlimited]
</dataset>
Schema Component Representation
<xs:element name="dataset" maxOccurs="unlimited" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="f" maxOccurs="unlimited" minOccurs="0"/>
<xs:element ref="row" maxOccurs="unlimited" minOccurs="0"/>
<xs:element ref="dataset" maxOccurs="unlimited" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="name"/>
</xs:complexType>
</xs:element>
top

Element: f

Name f
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Field returned from query. This is copied from the <f> elements from the definition, as a suggestion to stylesheets for further formatting.
XML Instance Representation
<f/>
Schema Component Representation
<xs:element name="f">
<xs:complexType>
<xs:attributeGroup>
<xs:attribute name="a"/>
<xs:attribute name="summary"/>
<xs:attribute name="format"/>
<xs:attribute name="formatopts"/>
</xs:attributeGroup>
</xs:complexType>
</xs:element>
top

Element: field

Name field
Type Locally-defined complex type
Nillable no
Abstract no
Documentation A single field in a row
XML Instance Representation
<field
name="anySimpleType [0..1] ?"
t="anySimpleType [0..1] ?"/>
Schema Component Representation
<xs:element name="field">
<xs:complexType mixed="true">
<xs:attribute name="name"/>
<xs:attribute name="t"/>
</xs:complexType>
</xs:element>
top

Element: messages

Name messages
Type Locally-defined complex type
Nillable no
Abstract no
Documentation
XML Instance Representation
<messages>
<message> ... </message> [1]
</messages>
Schema Component Representation
<xs:element name="messages" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="message"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: param

Name param
Type Locally-defined complex type
Nillable no
Abstract no
Documentation A GET varaible passed to report generation script.
XML Instance Representation
<param
name="anySimpleType [1]"
value="anySimpleType [1]"/>
Schema Component Representation
<xs:element name="param">
<xs:complexType>
<xs:attribute name="name" use="required"/>
<xs:attribute name="value" use="required"/>
</xs:complexType>
</xs:element>
top

Element: report

Name report
Type Locally-defined complex type
Nillable no
Abstract no
Documentation This is the root element of a FiForm Report result.
XML Instance Representation
<report>
<fiforms:reportdef> ... </fiforms:reportdef> [0..1]
<parameters> ... </parameters> [0..1]
<dataset> ... </dataset> [0..unlimited]
<messages> ... </messages> [1]
</report>
Schema Component Representation
<xs:element name="report">
<xs:complexType>
<xs:sequence>
<xs:element ref="fiforms:reportdef" minOccurs="0"/>
<xs:element ref="parameters" minOccurs="0"/>
<xs:element ref="dataset" maxOccurs="unlimited" minOccurs="0"/>
<xs:element ref="messages"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: row

Name row
Type Locally-defined complex type
Nillable no
Abstract no
Documentation
XML Instance Representation
<row
id="anySimpleType [1]">
<field> ... </field> [1]
</row>
Schema Component Representation
<xs:element name="row">
<xs:complexType>
<xs:sequence>
<xs:element ref="field"/>
</xs:sequence>
<xs:attribute name="id" use="required"/>
</xs:complexType>
</xs:element>
top

Legend

Complex Type:

Schema Component Type

AusAddress

Schema Component Name
Super-types: Address < AusAddress (by extension)
Sub-types:
  • QLDAddress (by restriction)
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
Name AusAddress
Abstract no
The table above displays the properties of this schema component.
XML Instance Representation
<... country="Australia">
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice[1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1]?
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

Schema Component Representation
<complexTypename="AusAddress">
<complexContent>
<extensionbase="Address">
<sequence>
<elementname="state" type="AusStates"/>
<elementname="postcode">
<simpleType>
<restrictionbase="string">
<patternvalue="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attributename="country" type="string" fixed="Australia"/>
</extension>
</complexContent>
</complexType>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
top

Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top