com.goldencode.p2j.schema

Class SchemaStatsHelper

java.lang.Object

com.goldencode.p2j.schema.SchemaStatsHelper

All Implemented Interfaces:

SourceFileHelper

public class SchemaStatsHelper
extends java.lang.Object
implements SourceFileHelper

Helper to copy and link to Progress 4GL schema source files.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	SchemaStatsHelper.SourceSpec Simple data structure to store key data for reverse mapping purposes.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String[]	headings Column headings.
private java.util.HashMap	reverse Store a reverse lookup from the schema name to the source file.

Constructor Summary

Constructors

Constructor and Description
SchemaStatsHelper()

Method Summary

Modifier and Type	Method and Description
void	addMapping(java.lang.String schema, java.lang.String source, boolean df) Add a mapping definition from the given schema name to the original source file that defined that schema.
java.lang.String[]	getHeadings() Obtain the list of source file descriptions which is suitable for use as the column headings in the source file index table.
CopySpec[]	getSpecifications(java.lang.String schema, java.lang.String outDir) Provide the list of copy specifications for the given source file and output directory.
java.lang.String	getURL(java.lang.String relPath, java.lang.String schema, java.lang.String line) Create a URL to link to the given source file and line number.

Methods inherited from class java.lang.Object

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

Field Detail

headings

private static final java.lang.String[] headings

Column headings.

reverse

private java.util.HashMap reverse

Store a reverse lookup from the schema name to the source file.

Constructor Detail

SchemaStatsHelper

public SchemaStatsHelper()

Method Detail

getHeadings

public java.lang.String[] getHeadings()

Obtain the list of source file descriptions which is suitable for use as the column headings in the source file index table.

Specified by:

getHeadings in interface SourceFileHelper

Returns:

Column headings.

getSpecifications

public CopySpec[] getSpecifications(java.lang.String schema,
                                    java.lang.String outDir)

Provide the list of copy specifications for the given source file and output directory.

Specified by:

getSpecifications in interface SourceFileHelper

Parameters:

schema - Schema AST filename.

outDir - Root of the output directory where all copies must be made.

Returns:

The list of source and target copy operations to be made.

getURL

public java.lang.String getURL(java.lang.String relPath,
                               java.lang.String schema,
                               java.lang.String line)

Create a URL to link to the given source file and line number.

Specified by:

getURL in interface SourceFileHelper

Parameters:

relPath - Relative path to the root of the output directory where the source files copies were made.

schema - Schema AST filename.

line - The line number to which to link.

Returns:

A URL to link to the copied file.

addMapping

public void addMapping(java.lang.String schema,
                       java.lang.String source,
                       boolean df)

Add a mapping definition from the given schema name to the original source file that defined that schema. This must be obtained from the schema AST files during any report processing. This is relied upon in order to properly determine the files for copying.

Parameters:

schema - The schema AST file name.

source - The source file.

df - true if this source file is a .df file.