com.fourjs.report.designtime

Class SchemaUtil

java.lang.Object

com.fourjs.report.designtime.SchemaUtil

public class SchemaUtil
extends java.lang.Object

Collection of utility functions for introspection of XML schema files

Since:

2.50

Constructor Summary

Constructors

Constructor and Description
SchemaUtil()

Method Summary

Modifier and Type	Method and Description
static com.fourjs.report.designtime.trigger.Field[]	getFields(java.lang.String schemaFileName, java.lang.String rootElementName, java.lang.String triggerNameConstraint) Returns all fields from the specified trigger extracted from the grammar in the XML schema file (.xsd).
static com.fourjs.report.designtime.trigger.Trigger	getTriggerTree(java.lang.String schemaFileName, java.lang.String rootElementName, java.lang.String[] fglRootElementName) Returns a "trigger tree" suited for matching the data described by the grammar in the XML schema file (.xsd).
static com.fourjs.report.designtime.trigger.Trigger	getTriggerTree(java.lang.String schemaFileName, java.lang.String systemId, java.lang.String rootElementName, java.lang.String[] fglRootElementName, java.lang.String filterId)
static com.fourjs.report.designtime.trigger.Trigger	getTriggerTree(java.net.URL schemaURL, java.lang.String rootElementName, java.lang.String[] fglRootElementName, int cutoffValue, java.lang.String filterId, boolean input)
static com.fourjs.report.designtime.trigger.Trigger	getTriggerTree(java.net.URL schemaURL, java.lang.String rootElementName, java.lang.String[] fglRootElementName, java.lang.String filterId)

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaUtil

public SchemaUtil()

Method Detail

getTriggerTree

public static com.fourjs.report.designtime.trigger.Trigger getTriggerTree(java.lang.String schemaFileName,
                                                                          java.lang.String rootElementName,
                                                                          java.lang.String[] fglRootElementName)
                                                                   throws DesignFileException

Returns a "trigger tree" suited for matching the data described by the grammar in the XML schema file (.xsd).

Parameters:

schemaFileName - Specifies an XML schema file (.xsd) describing the data source of the report.

rootElementName - Specifies the expected document root in the XML schema file (e.g. if the schema specifies the elements "invoice" and "invoice-batch" then rootElementName would be set to "invoice" if the report will be run against a source that produces documents whose root element is of type "invoice".

Returns:

a Trigger object that is the root of Specifies an XML schema file (.xsd) describing the data source of the report.

Throws:

DesignFileException - if the parse fails due to a IO error, a syntactic issue or the schema document does not meet the requirements.

getTriggerTree

public static com.fourjs.report.designtime.trigger.Trigger getTriggerTree(java.lang.String schemaFileName,
                                                                          java.lang.String systemId,
                                                                          java.lang.String rootElementName,
                                                                          java.lang.String[] fglRootElementName,
                                                                          java.lang.String filterId)
                                                                   throws DesignFileException

Throws:

DesignFileException

getTriggerTree

public static com.fourjs.report.designtime.trigger.Trigger getTriggerTree(java.net.URL schemaURL,
                                                                          java.lang.String rootElementName,
                                                                          java.lang.String[] fglRootElementName,
                                                                          int cutoffValue,
                                                                          java.lang.String filterId,
                                                                          boolean input)
                                                                   throws DesignFileException

Throws:

DesignFileException

getTriggerTree

public static com.fourjs.report.designtime.trigger.Trigger getTriggerTree(java.net.URL schemaURL,
                                                                          java.lang.String rootElementName,
                                                                          java.lang.String[] fglRootElementName,
                                                                          java.lang.String filterId)
                                                                   throws DesignFileException

Throws:

DesignFileException

getFields

public static com.fourjs.report.designtime.trigger.Field[] getFields(java.lang.String schemaFileName,
                                                                     java.lang.String rootElementName,
                                                                     java.lang.String triggerNameConstraint)
                                                              throws DesignFileException

Returns all fields from the specified trigger extracted from the grammar in the XML schema file (.xsd).

Parameters:

schemaFileName - Specifies an XML schema file (.xsd) describing the data source of the report.

rootElementName - Specifies the expected document root in the XML schema file (e.g. if the schema specifies the elements "invoice" and "invoice-batch" then rootElementName would be set to "invoice" if the report will be run against a source that produces documents whose root element is of type "invoice".

triggerNameConstraint - Specifies the trigger for which the fields are to be retrieved by it's element name constraint.

Returns:

an array of Field objects defined on the soecified trigger.

Throws:

DesignFileException - if the parse fails due to a IO error, a syntactic issue or the schema document does not meet the requirements.