com.pmease.quickbuild.plugin.report.engine.metadata
Class ReportCategory

java.lang.Object
  extended by com.pmease.quickbuild.plugin.report.engine.extensionpoint.AbstractTypedXMLObject
      extended by com.pmease.quickbuild.plugin.report.engine.metadata.ReportCategory
All Implemented Interfaces:
TypedObject, XMLSerializable, java.io.Serializable

public class ReportCategory
extends AbstractTypedXMLObject

See Also:
Serialized Form

Field Summary
static java.lang.String AGGREGATION_DIR
           
static ReportCategory EMPTY
           
protected  GeneratorRepository generatorRepository
           
static ReportCategory NULL_CATEGORY
           
protected  RendererRepository rendererRepository
           
static java.lang.String REPORTS_DIR
           
 
Constructor Summary
ReportCategory()
           
 
Method Summary
 void addGenerator(AbstractGenerator g)
           
 void addMeta(ReportMetaData meta)
           
 void addRenderer(AbstractRenderer r)
           
 java.io.File createCategoryDirOfAggregation(Configuration configuration)
           
 java.io.File createCategoryDirOfBuild(Build build)
           
 java.io.File createCategoryDirOfStats(Configuration configuration)
           
 DataReport createReport(java.lang.String reportName)
           
 void deleteAllReportSetsOfAggregation(Configuration configuration)
           
 void deleteAllReportSetsOfBuild(Build build)
           
 void deleteAllReportSetsOfStats(Configuration configuration)
           
protected  void deleteReportDir(java.io.File reportDir)
           
 void deleteReportSetOfAggregation(Configuration configuration, java.lang.String reportset)
           
 void deleteReportSetOfBuild(Build build, java.lang.String reportset)
           
 void deleteReportSetOfStats(Configuration configuration, java.lang.String reportset)
           
 boolean equals(java.lang.Object other)
           
 AbstractRenderer findRenderer(java.lang.String tabName, RendererMode mode)
           
 void fromXML(org.dom4j.Element node)
           
 CategoryDb getCategoryDb(java.io.File dir)
           
 java.io.File getCategoryDirOfAggregation(Configuration configuration)
           
 java.io.File getCategoryDirOfBuild(Build build)
           
 java.io.File getCategoryDirOfStats(Configuration configuration)
           
 java.lang.String getCategoryRelativeDir()
           
 java.lang.Class<? extends CategoryDbMigrator> getDbMigratorClass()
           
protected  java.lang.String getDefaultSql()
           
 java.util.Map<java.lang.String,java.lang.Object> getDefaultStats(CategoryDb db, java.lang.String reportName, Filter... filters)
           
 java.util.Map<java.lang.String,java.lang.Object> getDefaultStats(java.io.File dbDir, java.lang.String reportName, Filter... filters)
           
 java.lang.String getElementName()
           
 java.lang.String getExpressionTemplate(java.lang.String key)
           
 java.util.Map<java.lang.String,java.lang.String> getExpressionTemplates()
           
 GeneratorRepository getGeneratorRepository()
           
 ReportGenerator[] getGenerators(GeneratorStage stage)
           
 java.lang.String getId()
           
 java.lang.String getInitSql()
           
 ReportMetaData getMeta(java.lang.String reportName)
           
 ReportMetaData[] getMetas()
           
 ReportMetaData[] getMetas(ReportGroup group)
           
protected  MigrationExecutor getMigrationExecutor(java.io.File dir, MigrationContext context)
           
 java.lang.Class<? extends ReportCategoryMigrator> getMigratorClass()
           
 java.lang.String getName()
           
 int getOrder()
           
 ReportOverviewSetting getOverviewSetting()
           
 ReportRelation getRelation(java.lang.String parentName, java.lang.String childName)
           
 AbstractRenderer getRenderer(java.lang.String id)
           
 RendererRepository getRendererRepository()
           
 AbstractRenderer[] getRenderers(RendererMode mode)
           
 java.io.File getReportDirOfAggregation(Configuration configuration, java.lang.String aggregationName)
           
 java.io.File getReportDirOfBuild(Build build, java.lang.String reportset)
           
 java.io.File getReportDirOfStats(Configuration configuration, java.lang.String reportset)
           
 java.lang.String getReportSetRelativeDir(java.lang.String reportset)
           
 java.lang.String[] getReportSets(java.io.File categoryDir)
           
 java.lang.String[] getReportSetsOfAggregation(Configuration configuration)
           
 java.lang.String[] getReportSetsOfBuild(Build build)
           
 java.lang.String[] getReportSetsOfStats(Configuration configuration)
           
 long getRowsCount(java.io.File dbDir, SqlBuilder query)
           
 long getRowsCount(java.io.File dbDir, java.lang.String reportName)
           
 long getRowsCount(java.io.File dbDir, java.lang.String reportName, java.util.List<Filter> filters)
           
 java.lang.String getType()
           
 java.lang.String getVersion()
           
 int hashCode()
           
 boolean hasUnProcessedReport()
           
protected  boolean isReportDir(java.io.File dir)
           
 DataReport loadReport(java.io.File dbDir, ReportDataSource rds)
           
 DataReport loadReport(java.io.File dbDir, SqlBuilder query)
           
 DataReport loadReport(java.io.File dbDir, java.lang.String reportName, Filter... filters)
           
 void optimizeDb(java.io.File dbDir)
           
 void removeMeta(java.lang.String reportName)
           
 void removeRenderer(java.lang.String id)
           
 void saveReport(CategoryDb db, DataReport report)
           
 void saveReport(java.io.File dbDir, DataReport report)
           
 void saveReport(java.io.File dbDir, DataReport report, MergeFunction<DataRow> rowMerger)
           
 void setExpressionTemplates(java.util.Map<java.lang.String,java.lang.String> expressionTemplates)
           
 void setId(java.lang.String id)
           
 void setInitSql(java.lang.String sql)
           
 void setName(java.lang.String name)
           
 void setOrder(int order)
           
 void setOverviewSetting(ReportOverviewSetting overviewSetting)
           
 void setVersion(java.lang.String version)
           
 java.lang.String toString()
           
 org.dom4j.Element toXML()
           
 void upgrade(java.io.File categoryDir, MigrationContext context)
           
 void writeVersionFile(java.io.File dir)
           
 
Methods inherited from class com.pmease.quickbuild.plugin.report.engine.extensionpoint.AbstractTypedXMLObject
initFromClassResource, initFromLocal, initFromStream, reflectionReadFromNode, reflectionWriteToNode
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

NULL_CATEGORY

public static ReportCategory NULL_CATEGORY

REPORTS_DIR

public static final java.lang.String REPORTS_DIR
See Also:
Constant Field Values

AGGREGATION_DIR

public static final java.lang.String AGGREGATION_DIR
See Also:
Constant Field Values

EMPTY

public static final ReportCategory EMPTY

generatorRepository

protected final GeneratorRepository generatorRepository

rendererRepository

protected final RendererRepository rendererRepository
Constructor Detail

ReportCategory

public ReportCategory()
Method Detail

hasUnProcessedReport

public boolean hasUnProcessedReport()

getMetas

public ReportMetaData[] getMetas(ReportGroup group)

getMeta

public ReportMetaData getMeta(java.lang.String reportName)

getGenerators

public ReportGenerator[] getGenerators(GeneratorStage stage)

findRenderer

public AbstractRenderer findRenderer(java.lang.String tabName,
                                     RendererMode mode)

getRenderers

public AbstractRenderer[] getRenderers(RendererMode mode)

getRenderer

public AbstractRenderer getRenderer(java.lang.String id)

createReport

public DataReport createReport(java.lang.String reportName)

fromXML

public void fromXML(org.dom4j.Element node)
             throws ReportException
Specified by:
fromXML in interface XMLSerializable
Overrides:
fromXML in class AbstractTypedXMLObject
Throws:
ReportException

getDefaultSql

protected java.lang.String getDefaultSql()

toXML

public org.dom4j.Element toXML()
                        throws ReportException
Specified by:
toXML in interface XMLSerializable
Overrides:
toXML in class AbstractTypedXMLObject
Throws:
ReportException

writeVersionFile

public void writeVersionFile(java.io.File dir)

getCategoryDb

public CategoryDb getCategoryDb(java.io.File dir)

getRowsCount

public long getRowsCount(java.io.File dbDir,
                         SqlBuilder query)

getRowsCount

public long getRowsCount(java.io.File dbDir,
                         java.lang.String reportName,
                         java.util.List<Filter> filters)

getRowsCount

public long getRowsCount(java.io.File dbDir,
                         java.lang.String reportName)

loadReport

public DataReport loadReport(java.io.File dbDir,
                             SqlBuilder query)

loadReport

public DataReport loadReport(java.io.File dbDir,
                             ReportDataSource rds)

loadReport

public DataReport loadReport(java.io.File dbDir,
                             java.lang.String reportName,
                             Filter... filters)

saveReport

public void saveReport(java.io.File dbDir,
                       DataReport report,
                       MergeFunction<DataRow> rowMerger)

saveReport

public void saveReport(java.io.File dbDir,
                       DataReport report)

saveReport

public void saveReport(CategoryDb db,
                       DataReport report)

getDefaultStats

public java.util.Map<java.lang.String,java.lang.Object> getDefaultStats(java.io.File dbDir,
                                                                        java.lang.String reportName,
                                                                        Filter... filters)

getDefaultStats

public java.util.Map<java.lang.String,java.lang.Object> getDefaultStats(CategoryDb db,
                                                                        java.lang.String reportName,
                                                                        Filter... filters)

optimizeDb

public void optimizeDb(java.io.File dbDir)

createCategoryDirOfBuild

public java.io.File createCategoryDirOfBuild(Build build)

createCategoryDirOfStats

public java.io.File createCategoryDirOfStats(Configuration configuration)

createCategoryDirOfAggregation

public java.io.File createCategoryDirOfAggregation(Configuration configuration)

getCategoryDirOfBuild

public java.io.File getCategoryDirOfBuild(Build build)

getCategoryDirOfStats

public java.io.File getCategoryDirOfStats(Configuration configuration)

getCategoryDirOfAggregation

public java.io.File getCategoryDirOfAggregation(Configuration configuration)

getCategoryRelativeDir

public java.lang.String getCategoryRelativeDir()

getReportSetRelativeDir

public java.lang.String getReportSetRelativeDir(java.lang.String reportset)

getReportSetsOfBuild

public java.lang.String[] getReportSetsOfBuild(Build build)

getReportSetsOfStats

public java.lang.String[] getReportSetsOfStats(Configuration configuration)

getReportSetsOfAggregation

public java.lang.String[] getReportSetsOfAggregation(Configuration configuration)

deleteReportDir

protected void deleteReportDir(java.io.File reportDir)

deleteReportSetOfBuild

public void deleteReportSetOfBuild(Build build,
                                   java.lang.String reportset)

deleteAllReportSetsOfBuild

public void deleteAllReportSetsOfBuild(Build build)

deleteReportSetOfStats

public void deleteReportSetOfStats(Configuration configuration,
                                   java.lang.String reportset)

deleteAllReportSetsOfStats

public void deleteAllReportSetsOfStats(Configuration configuration)

deleteReportSetOfAggregation

public void deleteReportSetOfAggregation(Configuration configuration,
                                         java.lang.String reportset)

deleteAllReportSetsOfAggregation

public void deleteAllReportSetsOfAggregation(Configuration configuration)

isReportDir

protected boolean isReportDir(java.io.File dir)

getReportSets

public java.lang.String[] getReportSets(java.io.File categoryDir)

getReportDirOfBuild

public java.io.File getReportDirOfBuild(Build build,
                                        java.lang.String reportset)

getReportDirOfStats

public java.io.File getReportDirOfStats(Configuration configuration,
                                        java.lang.String reportset)

getReportDirOfAggregation

public java.io.File getReportDirOfAggregation(Configuration configuration,
                                              java.lang.String aggregationName)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getVersion

public java.lang.String getVersion()

setVersion

public void setVersion(java.lang.String version)

getOrder

public int getOrder()

setOrder

public void setOrder(int order)

getMetas

public ReportMetaData[] getMetas()

addMeta

public void addMeta(ReportMetaData meta)

removeMeta

public void removeMeta(java.lang.String reportName)

getRelation

public ReportRelation getRelation(java.lang.String parentName,
                                  java.lang.String childName)

getId

public java.lang.String getId()

setId

public void setId(java.lang.String id)

getRendererRepository

public RendererRepository getRendererRepository()

addRenderer

public void addRenderer(AbstractRenderer r)

removeRenderer

public void removeRenderer(java.lang.String id)

getGeneratorRepository

public GeneratorRepository getGeneratorRepository()

addGenerator

public void addGenerator(AbstractGenerator g)

getExpressionTemplates

public java.util.Map<java.lang.String,java.lang.String> getExpressionTemplates()

setExpressionTemplates

public void setExpressionTemplates(java.util.Map<java.lang.String,java.lang.String> expressionTemplates)

getExpressionTemplate

public java.lang.String getExpressionTemplate(java.lang.String key)

getOverviewSetting

public ReportOverviewSetting getOverviewSetting()

setOverviewSetting

public void setOverviewSetting(ReportOverviewSetting overviewSetting)

getInitSql

public java.lang.String getInitSql()

setInitSql

public void setInitSql(java.lang.String sql)

upgrade

public void upgrade(java.io.File categoryDir,
                    MigrationContext context)

getMigrationExecutor

protected MigrationExecutor getMigrationExecutor(java.io.File dir,
                                                 MigrationContext context)

getMigratorClass

public java.lang.Class<? extends ReportCategoryMigrator> getMigratorClass()

getDbMigratorClass

public java.lang.Class<? extends CategoryDbMigrator> getDbMigratorClass()

getElementName

public java.lang.String getElementName()
Specified by:
getElementName in class AbstractTypedXMLObject

getType

public java.lang.String getType()

equals

public boolean equals(java.lang.Object other)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object


Copyright © 2005-2010 PMEase Inc. All Rights Reserved.