Package org.linuxforhealth.fhir.schema.size

Class ReadableSizeReport

java.lang.Object

org.linuxforhealth.fhir.schema.size.ReadableSizeReport

All Implemented Interfaces:

FHIRDbSizeModelVisitor, ISizeReport

public class ReadableSizeReport
extends java.lang.Object
implements ISizeReport, FHIRDbSizeModelVisitor

A human readable report showing the breakdown of size/usage in the FHIR data schema.

Constructor Summary

Constructors

Constructor	Description
ReadableSizeReport(java.io.Writer output, boolean includeDetail)	Public constructor

Method Summary

Modifier and Type	Method	Description
void	index(java.lang.String resourceType, java.lang.String tableName, java.lang.String indexName, long indexSize)	The size of an index
void	render(FHIRDbSizeModel model)	Render a report using the data from the given model
void	renderParameterSummary(java.lang.String parameterTable, long rowEstimate, long totalTableSize, long tableSize, long totalIndexSize, long indexSize)	Render the parameter summary for the given parameter table name
void	resource(java.lang.String resourceType, long logicalResourceRowEstimate, long resourceRowEstimate, long totalTableSize, long totalIndexSize, long rowEstimate, long resourceTableSize, long resourceIndexSize)	Resource-level summary
void	start()	Called once before any of the other methods
void	table(java.lang.String resourceType, java.lang.String parameterTable, boolean isParameterTable, long rowEstimate, long paramTableSize, long paramIndexSize)	The size of a table

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadableSizeReport

public ReadableSizeReport(java.io.Writer output,
                          boolean includeDetail)

Public constructor

Parameters:

output -

Method Detail

render

public void render(FHIRDbSizeModel model)

Description copied from interface: ISizeReport

Render a report using the data from the given model

Specified by:

render in interface ISizeReport

start

public void start()

Description copied from interface: FHIRDbSizeModelVisitor

Called once before any of the other methods

Specified by:

start in interface FHIRDbSizeModelVisitor

resource

public void resource(java.lang.String resourceType,
                     long logicalResourceRowEstimate,
                     long resourceRowEstimate,
                     long totalTableSize,
                     long totalIndexSize,
                     long rowEstimate,
                     long resourceTableSize,
                     long resourceIndexSize)

Description copied from interface: FHIRDbSizeModelVisitor

Resource-level summary

Specified by:

resource in interface FHIRDbSizeModelVisitor

Parameters:

resourceType - the FHIR resource type name

logicalResourceRowEstimate - estimate of rows in xx_logical_resources

resourceRowEstimate - estimate of rows in xx_resources

totalTableSize - the database level total table size

totalIndexSize - the database level total index size

rowEstimate - the estimated number of row across all tables for the given resource

resourceTableSize - the resource level total table size

resourceIndexSize - the resource level total index size

table

public void table(java.lang.String resourceType,
                  java.lang.String parameterTable,
                  boolean isParameterTable,
                  long rowEstimate,
                  long paramTableSize,
                  long paramIndexSize)

Description copied from interface: FHIRDbSizeModelVisitor

The size of a table

Specified by:

table in interface FHIRDbSizeModelVisitor

index

public void index(java.lang.String resourceType,
                  java.lang.String tableName,
                  java.lang.String indexName,
                  long indexSize)

Description copied from interface: FHIRDbSizeModelVisitor

The size of an index

Specified by:

index in interface FHIRDbSizeModelVisitor

renderParameterSummary

public void renderParameterSummary(java.lang.String parameterTable,
                                   long rowEstimate,
                                   long totalTableSize,
                                   long tableSize,
                                   long totalIndexSize,
                                   long indexSize)

Description copied from interface: ISizeReport

Render the parameter summary for the given parameter table name

Specified by:

renderParameterSummary in interface ISizeReport