com.goldencode.p2j.report

Class ConfigurationPersistence

java.lang.Object

com.goldencode.p2j.report.ConfigurationPersistence

All Implemented Interfaces:

ReportConstants, XmlConstants

public class ConfigurationPersistence
extends java.lang.Object
implements XmlConstants, ReportConstants

Helper object to persist and load report-related configuration to and from XML. This is used to export and import various bits of configuration created by users using the web application, which must survive database recreates.

Currently, the following information is handled by this mechanism:

• User-defined report definitions.
• User credentials.
• Search history (TRPL expressions used in searches and custom reports).
• Filter profile definitions.

Field Summary

Fields inherited from interface com.goldencode.p2j.report.XmlConstants

ATTR_ADMIN, ATTR_COND, ATTR_DB, ATTR_DUMPEXPR, ATTR_DUMPLVL, ATTR_DUMPTYPE, ATTR_ID, ATTR_MULTIPLEX, ATTR_NAME, ATTR_PASS_CHANGED, ATTR_PASSWORD, ATTR_SALT, ATTR_SORT, ATTR_SPEC, ATTR_SUPPORT, ATTR_TAG, ATTR_TITLE, ATTR_USER, ATTR_WILD, AUTO_EXPORT_FILTER_PATH, AUTO_EXPORT_RPT_SPEC, AUTO_EXPORT_SRCH_PATH, AUTO_EXPORT_USER_PATH, ELEM_FILTER, ELEM_LIST, ELEM_PROFILE, ELEM_RPT, ELEM_SEARCH, ELEM_USER, RPT_PATH, RPT_SUFFIX

Fields inherited from interface com.goldencode.p2j.report.ReportConstants

CVT_LVL_BASIC, CVT_LVL_FULL, CVT_LVL_FULL_RESTR, CVT_LVL_MASK, CVT_LVL_NONE, CVT_LVL_PARTIAL, LVL_UNKNOWN, RT_LVL_BASIC, RT_LVL_FULL, RT_LVL_FULL_RESTR, RT_LVL_MASK, RT_LVL_NONE, RT_LVL_PARTIAL, RT_LVL_STUB, RT_LVL_UNTESTED, SORT_ALL, SORT_NONE, SORT_NOT_LAST, SRC_CODE_BASE, SRC_CODE_CACHE, SRC_SCHEMA, SRC_UNKNOWN

Constructor Summary

Constructors

Constructor and Description
ConfigurationPersistence() Default constructor.

Method Summary

Modifier and Type	Method and Description
java.util.List<FilterProfile>	readXmlFilters(java.io.File file) Read the given file, which is expected to contain an XML document defining one or more file filter profiles.
int	readXmlReports(java.io.File file, java.util.List<ReportDefinition> reports) Read the given file, which is expected to contain an XML document defining one or more reports.
java.util.List<SearchHistory>	readXmlSearches(java.io.File file) Read the given file, which is expected to contain an XML document defining one or more search history entries.
java.util.List<UserRecord>	readXmlUsers(java.io.File file) Read the given file, which is expected to contain an XML document defining one or more sets of user credentials.
void	writeXmlFilters(java.io.File file, java.util.List<FilterProfile> profiles) Create a new XML document and export the given list of file filter profiles into it.
void	writeXmlReports(java.io.File file, java.util.List<ReportDefinition> reports, boolean schema) Create a new XML document and export the given list of report definitions into it.
void	writeXmlSearches(java.io.File file, java.util.List<SearchHistory> searches) Create a new XML document and export the given list of search history entries into it.
void	writeXmlUsers(java.io.File file, java.util.List<UserRecord> users) Create a new XML document and export the given list of user credentials into it.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationPersistence

public ConfigurationPersistence()

Default constructor.

Method Detail

readXmlReports

public int readXmlReports(java.io.File file,
                          java.util.List<ReportDefinition> reports)
                   throws javax.xml.parsers.ParserConfigurationException,
                          java.io.IOException,
                          org.xml.sax.SAXException

Read the given file, which is expected to contain an XML document defining one or more reports. Add each report definition to the given list.

Parameters:

file - File containing XML report definitions.

reports - List of report definitions to be populated with those read from the file.

Returns:

Type of reports contained in the file; or 0 if file does not exist or is not valid.

Throws:

javax.xml.parsers.ParserConfigurationException - if there is an error configuring the XML parser.

org.xml.sax.SAXException - if the XML SAX parser encounters an error.

java.io.IOException - if there is an error accessing the file.

writeXmlReports

public void writeXmlReports(java.io.File file,
                            java.util.List<ReportDefinition> reports,
                            boolean schema)
                     throws javax.xml.parsers.ParserConfigurationException,
                            java.io.IOException

Create a new XML document and export the given list of report definitions into it. Save the document into this object's file, which will be created if it does not exist. If the file already exists, it is overwritten without confirmation.

Parameters:

file - Destination file.

reports - List of report definitions to write.

schema - True if reports are schema reports; false if they are code reports.

Throws:

javax.xml.parsers.ParserConfigurationException - if there is an XML parser configuration error.

java.io.IOException - if there is an error writing the XML content to the file system.

readXmlUsers

public java.util.List<UserRecord> readXmlUsers(java.io.File file)
                                        throws javax.xml.parsers.ParserConfigurationException,
                                               java.io.IOException,
                                               org.xml.sax.SAXException

Read the given file, which is expected to contain an XML document defining one or more sets of user credentials. Return the list of entries read.

Parameters:

file - File containing XML user credentials.

Returns:

List of user credential entries; may be empty, but will not be null.

Throws:

javax.xml.parsers.ParserConfigurationException - if there is an error configuring the XML parser.

org.xml.sax.SAXException - if the XML SAX parser encounters an error.

java.io.IOException - if there is an error accessing the file.

writeXmlUsers

public void writeXmlUsers(java.io.File file,
                          java.util.List<UserRecord> users)
                   throws javax.xml.parsers.ParserConfigurationException,
                          java.io.IOException

Create a new XML document and export the given list of user credentials into it. Save the document into this object's file, which will be created if it does not exist. If the file already exists, it is overwritten without confirmation.

Parameters:

file - Destination file.

users - List of user credential records to write.

Throws:

javax.xml.parsers.ParserConfigurationException - if there is an XML parser configuration error.

java.io.IOException - if there is an error writing the XML content to the file system.

readXmlFilters

public java.util.List<FilterProfile> readXmlFilters(java.io.File file)
                                             throws javax.xml.parsers.ParserConfigurationException,
                                                    java.io.IOException,
                                                    org.xml.sax.SAXException

Read the given file, which is expected to contain an XML document defining one or more file filter profiles. Return the list of entries read.

Parameters:

file - File containing XML filter profile data.

Returns:

List of filter profiles; may be empty, but will not be null.

Throws:

javax.xml.parsers.ParserConfigurationException - if there is an error configuring the XML parser.

org.xml.sax.SAXException - if the XML SAX parser encounters an error.

java.io.IOException - if there is an error accessing the file.

writeXmlFilters

public void writeXmlFilters(java.io.File file,
                            java.util.List<FilterProfile> profiles)
                     throws javax.xml.parsers.ParserConfigurationException,
                            java.io.IOException

Create a new XML document and export the given list of file filter profiles into it. Save the document into this object's file, which will be created if it does not exist. If the file already exists, it is overwritten without confirmation.

Parameters:

file - Destination file.

profiles - List of filter profiles to write.

Throws:

javax.xml.parsers.ParserConfigurationException - if there is an XML parser configuration error.

java.io.IOException - if there is an error writing the XML content to the file system.

readXmlSearches

public java.util.List<SearchHistory> readXmlSearches(java.io.File file)
                                              throws javax.xml.parsers.ParserConfigurationException,
                                                     java.io.IOException,
                                                     org.xml.sax.SAXException

Read the given file, which is expected to contain an XML document defining one or more search history entries. Return the list of entries read.

Parameters:

file - File containing XML search history.

Returns:

List of search history entries; may be empty, but will not be null.

Throws:

javax.xml.parsers.ParserConfigurationException - if there is an error configuring the XML parser.

org.xml.sax.SAXException - if the XML SAX parser encounters an error.

java.io.IOException - if there is an error accessing the file.

writeXmlSearches

public void writeXmlSearches(java.io.File file,
                             java.util.List<SearchHistory> searches)
                      throws javax.xml.parsers.ParserConfigurationException,
                             java.io.IOException

Create a new XML document and export the given list of search history entries into it. Save the document into this object's file, which will be created if it does not exist. If the file already exists, it is overwritten without confirmation.

Parameters:

file - Destination file.

searches - List of search history entries to write.

Throws:

javax.xml.parsers.ParserConfigurationException - if there is an XML parser configuration error.

java.io.IOException - if there is an error writing the XML content to the file system.