by.belsoft.report.tools.reportdb
Class XmlUtilities

java.lang.Object
  |
  +--by.belsoft.report.tools.actions.ContextData
        |
        +--by.belsoft.report.tools.reportdb.XmlUtilities

public class XmlUtilities

extends ContextData

The class to work with xml database

Author:

Ilya Kirillov

Constructor Summary

XmlUtilities()
The base constructor

Method Summary

void	addDataSource(DataSource ds) addDataSource adds new datasource
void	addDriver(java.lang.String name) addDriver adds driver
void	addReport(Report project) addReport add new report
void	addReportContent(Query query) addReportContent adds report content
void	addView(BaseTakenUp table, java.lang.String report) addView adds view
DataSource	getDataSource(java.lang.String name) getDataSource gets datasource
java.util.ArrayList	getDataSourceObjects() getDataSourceObjects gets datasource objects
java.util.ArrayList	getDataSources() getDataSources gets list with datasources
java.util.ArrayList	getDrivers() getDrivers gets drivers
Field	getField(java.lang.String fieldid) getField gets field by id
java.util.ArrayList	getParentFields(java.lang.String reportname, java.lang.String queryname) getParentFields gets parent fields
java.util.ArrayList	getPropertyTables() getPropertyTables gets list of property tables
java.util.ArrayList	getQueriesList() getQueriesList gets list of queries
Query	getQuery(java.lang.String reportname, java.lang.String queryname) getQuery gets query by given data
java.lang.String	getReportContent(java.lang.String name) getReportContent gets report contant
java.util.ArrayList	getReports() getReports gets report list
BaseTakenUp	getSavedContainer() getSavedContainer gets saved view container
BaseTakenUp	getSavedTable(java.lang.String id) getSavedTable gets saved table
BaseTakenUp	getStructureContainer() getStructureContainer gets structure container
java.util.ArrayList	getStructureTables() getStructureTables gets structure tables
java.util.ArrayList	getTables() getTables gets view tables
java.lang.String	getXMLSource(Query query) getXMLSource gets xml source from query
void	makeDefaultDataDocument(org.w3c.dom.Document defaultDocument, org.w3c.dom.Element currentDataElement, org.w3c.dom.Element currentQueryElement) makeDefaultDataDocument makes default data document
void	makeDefaultDataXMLFile(java.lang.String dataXMLFilePath, java.lang.String queryXMLFilePath) makeDefaultDataXMLFile makes default data xml file
org.w3c.dom.Document	makeDocument(java.io.File file) makeDocument makes document from file
org.w3c.dom.Document	makeDocument(org.xmldb.api.modules.XMLResource document) makeDocument makes document from xml resource
void	makeViewXMLFragment(BaseTakenUp baseTakenUp, java.lang.String viewXMLFilePath, java.lang.String reportDIR) makeViewXMLFragment makes view xml fragment
org.xmldb.api.base.Collection	prepareCollection(java.lang.String name) prepareCollection prepares collection to extract data
void	removeDataSource(java.lang.String name) removeDataSource removes datasource
void	removeDataSources(java.lang.String[] names) removeDataSources removes datasources
void	removeDriver(java.lang.String name) removeDriver removes driver
java.lang.String	removeFromReportContent(java.lang.String cont) removeFromReportContent removes unnecessary data from report content
void	removeQuery(java.lang.String name) removeQuery removes query from report
void	removeReport(java.lang.String name) removeReport removes report
void	removeReports(java.lang.String[] names) removeReports removes report group
void	removeUnusedRows() removeUnusedRows removes unnecessary rows from content
void	saveAllDataToFiles(java.lang.String name, java.lang.String directory) saveAllDataToFiles saves all report data to files
void	saveDocumentToFile(org.w3c.dom.Document document, java.lang.String path, java.lang.String dtdPath) saveDocumentToFile saves document to file
java.lang.String	saveDriver(java.lang.String name, java.io.InputStream is) saveDriver saves driver into driver folder
java.lang.String	saveFile(java.lang.String path, java.io.File ftmp, java.io.InputStream is) saveFile saves file
java.lang.String	saveFile(java.lang.String name, java.io.InputStream is) saveFile saves file to report folder
void	saveQueryFile(java.lang.String name, java.lang.String directory) saveQueryFile saves query file
void	saveViewFile(java.lang.String name, java.lang.String directory) saveViewFile saves view file
void	updateDataSource(DataSource ds) updateDataSource updates datasource
BaseTakenUp	updateGeneralViewContainer(BaseTakenUp container) updateGeneralViewContainer updates general view container
void	updateQuery(Query query) updateQuery updates query
void	updateReport() updateReport updates report data
BaseTakenUp	updateView(BaseTakenUp table) updateView updates report view
void	write(org.w3c.dom.Node node, java.lang.String indent) write method that writes xml source

Methods inherited from class by.belsoft.report.tools.actions.ContextData

getContext, getReportName, getRequest, getSession, setRefreshData

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlUtilities

public XmlUtilities()

The base constructor

Method Detail

getReports

public java.util.ArrayList getReports()

getReports gets report list

Returns:

ArrayList the result list

updateReport

public void updateReport()

updateReport updates report data

removeReport

public void removeReport(java.lang.String name)

removeReport removes report

Parameters:

name - String the report name

removeReports

public void removeReports(java.lang.String[] names)

removeReports removes report group

Parameters:

names - String[] the report names

addReport

public void addReport(Report project)

addReport add new report

Parameters:

project - Report the report to add

addReportContent

public void addReportContent(Query query)

addReportContent adds report content

Parameters:

query - Query the general container to add

getDataSources

public java.util.ArrayList getDataSources()

getDataSources gets list with datasources

Returns:

ArrayList the result list

getDataSourceObjects

public java.util.ArrayList getDataSourceObjects()

getDataSourceObjects gets datasource objects

Returns:

ArrayList the list of datasource objects

getDataSource

public DataSource getDataSource(java.lang.String name)

getDataSource gets datasource

Parameters:

name - String the datasource name

Returns:

DataSource the result datasource

addDataSource

public void addDataSource(DataSource ds)

addDataSource adds new datasource

Parameters:

ds - DataSource the datasource to add

updateDataSource

public void updateDataSource(DataSource ds)

updateDataSource updates datasource

Parameters:

ds - DataSource the datasource to be updated

removeDataSource

public void removeDataSource(java.lang.String name)

removeDataSource removes datasource

Parameters:

name - String the name of datasource

removeDataSources

public void removeDataSources(java.lang.String[] names)

removeDataSources removes datasources

Parameters:

names - String[] the datasource names

getDrivers

public java.util.ArrayList getDrivers()

getDrivers gets drivers

Returns:

ArrayList the list of drivers

addDriver

public void addDriver(java.lang.String name)

addDriver adds driver

Parameters:

name - String the driver name

removeDriver

public void removeDriver(java.lang.String name)

removeDriver removes driver

Parameters:

name - String the driver name

updateQuery

public void updateQuery(Query query)

updateQuery updates query

Parameters:

query - Query the query to be updated

addView

public void addView(BaseTakenUp table,
                    java.lang.String report)

addView adds view

Parameters:

table - BaseTakenUp adds report container

report - String the report name

getSavedTable

public BaseTakenUp getSavedTable(java.lang.String id)

getSavedTable gets saved table

Parameters:

id - String the tabe id

Returns:

BaseTakenUp the result container

updateView

public BaseTakenUp updateView(BaseTakenUp table)

updateView updates report view

Parameters:

table - BaseTakenUp the view container

Returns:

BaseTakenUp the result container

updateGeneralViewContainer

public BaseTakenUp updateGeneralViewContainer(BaseTakenUp container)

updateGeneralViewContainer updates general view container

Parameters:

container - BaseTakenUp the view container

Returns:

BaseTakenUp the result container

getQueriesList

public java.util.ArrayList getQueriesList()

getQueriesList gets list of queries

Returns:

ArrayList the list of queries

getQuery

public Query getQuery(java.lang.String reportname,
                      java.lang.String queryname)

getQuery gets query by given data

Parameters:

reportname - String the report name

queryname - String the query name

Returns:

Query the result query

getReportContent

public java.lang.String getReportContent(java.lang.String name)

getReportContent gets report contant

Parameters:

name - String the report name

Returns:

String the report content

removeFromReportContent

public java.lang.String removeFromReportContent(java.lang.String cont)

removeFromReportContent removes unnecessary data from report content

Parameters:

cont - String the content to remove

Returns:

String the result content

removeUnusedRows

public void removeUnusedRows()

removeUnusedRows removes unnecessary rows from content

removeQuery

public void removeQuery(java.lang.String name)

removeQuery removes query from report

Parameters:

name - String the query name

getParentFields

public java.util.ArrayList getParentFields(java.lang.String reportname,
                                           java.lang.String queryname)

getParentFields gets parent fields

Parameters:

reportname - String the report name

queryname - String the query name

Returns:

ArrayList the list of parent fields

getTables

public java.util.ArrayList getTables()

getTables gets view tables

Returns:

ArrayList the list of tables

getPropertyTables

public java.util.ArrayList getPropertyTables()

getPropertyTables gets list of property tables

Returns:

ArrayList the list of tables

getStructureTables

public java.util.ArrayList getStructureTables()

getStructureTables gets structure tables

Returns:

ArrayList the list of tables

getSavedContainer

public BaseTakenUp getSavedContainer()

getSavedContainer gets saved view container

Returns:

BaseTakenUp the result container

getStructureContainer

public BaseTakenUp getStructureContainer()

getStructureContainer gets structure container

Returns:

BaseTakenUp the result container

getField

public Field getField(java.lang.String fieldid)

getField gets field by id

Parameters:

fieldid - String the field id

Returns:

Field the result field

getXMLSource

public java.lang.String getXMLSource(Query query)

getXMLSource gets xml source from query

Parameters:

query - Query the query to parse

Returns:

String theresult source

saveAllDataToFiles

public void saveAllDataToFiles(java.lang.String name,
                               java.lang.String directory)

saveAllDataToFiles saves all report data to files

Parameters:

name - String the report name

directory - String the directory to save

saveQueryFile

public void saveQueryFile(java.lang.String name,
                          java.lang.String directory)

saveQueryFile saves query file

Parameters:

name - String the report name

directory - String the directory to save

saveViewFile

public void saveViewFile(java.lang.String name,
                         java.lang.String directory)

saveViewFile saves view file

Parameters:

name - String the report name

directory - String the directory to save

saveFile

public java.lang.String saveFile(java.lang.String name,
                                 java.io.InputStream is)

saveFile saves file to report folder

Parameters:

name - String the file name

is - InputStream the file input stream

Returns:

String the path to return

saveDriver

public java.lang.String saveDriver(java.lang.String name,
                                   java.io.InputStream is)

saveDriver saves driver into driver folder

Parameters:

name - String the file name

is - InputStream the file input stream

Returns:

String the path to return

saveFile

public java.lang.String saveFile(java.lang.String path,
                                 java.io.File ftmp,
                                 java.io.InputStream is)

saveFile saves file

Parameters:

path - String the file path

ftmp - File the file object

is - InputStream the file input stream

Returns:

String the path to return

saveDocumentToFile

public void saveDocumentToFile(org.w3c.dom.Document document,
                               java.lang.String path,
                               java.lang.String dtdPath)

saveDocumentToFile saves document to file

Parameters:

document - Document the document element

path - String the path for saving

dtdPath - String the dtd path

makeDefaultDataDocument

public void makeDefaultDataDocument(org.w3c.dom.Document defaultDocument,
                                    org.w3c.dom.Element currentDataElement,
                                    org.w3c.dom.Element currentQueryElement)

makeDefaultDataDocument makes default data document

Parameters:

defaultDocument - Document the default document

currentDataElement - Element the current data element

currentQueryElement - Element the current query element

makeViewXMLFragment

public void makeViewXMLFragment(BaseTakenUp baseTakenUp,
                                java.lang.String viewXMLFilePath,
                                java.lang.String reportDIR)

makeViewXMLFragment makes view xml fragment

Parameters:

baseTakenUp - BaseTakenUp the container to make fragment

viewXMLFilePath - String the path to view xml file

reportDIR - String the report directory

makeDefaultDataXMLFile

public void makeDefaultDataXMLFile(java.lang.String dataXMLFilePath,
                                   java.lang.String queryXMLFilePath)

makeDefaultDataXMLFile makes default data xml file

Parameters:

dataXMLFilePath - String the path to query xml file

queryXMLFilePath - String the path to view xml file

makeDocument

public org.w3c.dom.Document makeDocument(java.io.File file)

makeDocument makes document from file

Parameters:

file - File the file to make document

Returns:

Document the document element

makeDocument

public org.w3c.dom.Document makeDocument(org.xmldb.api.modules.XMLResource document)

makeDocument makes document from xml resource

Parameters:

document - XMLResource the xml resource to make document

Returns:

Document the document element

prepareCollection

public org.xmldb.api.base.Collection prepareCollection(java.lang.String name)

prepareCollection prepares collection to extract data

Parameters:

name - String the report name

Returns:

Collection the collection prepared

write

public void write(org.w3c.dom.Node node,
                  java.lang.String indent)

write method that writes xml source

Parameters:

node - Node the node to be written

indent - String the output indent