com.goldencode.p2j.e4gl

Class BlueDiamondHelper

java.lang.Object

com.goldencode.p2j.e4gl.BaseHelper

com.goldencode.p2j.e4gl.BlueDiamondHelper

All Implemented Interfaces:

CompatibilityHelper

public class BlueDiamondHelper
extends BaseHelper

Assists in creating Blue Diamond specific output text.

Compatibility notes:

• Blue Diamond does not escape semicolons or tildes when converting raw HTML to strings, that is a bug so it is not reproduced
• Blue Diamond does not honor the keep-meta-content-type option but there seems no reason not to do so
• Blue Diamond has flaws in its (META or WSMETA element) options parsing that are not reproduced (it may not find options that are actually coded so it will silently ignored these options)
• Blue Diamond drops blank raw HTML lines but this would cause problems in PRE elements so this is not duplicated (they tried to do this for efficiency but it seems that this was an unexpected result)
• Blue Diamond has parsing limitations with handling some input spread across multiple lines so it is expected that all such problems have been eliminated from input source, the fact that the E4GLParser doesn't duplicate these limitations should not cause any issues (e.g. statement and expression escapes must be on their own lines in Blue Diamond, there can't be a mixture of raw HTML and partial escapes on the same line)
• Blue Diamond does not recognize all valid WebSpeed statement and expression escapes, but this is not duplicated since these other escapes should not be present in code that works with Blue Diamond
• Blue Diamond does not handle the entity replacement and URL character encoding that is done by some HTML authoring tools when those tools are used to input E4GL in embedded expressions and/or embedded statements; these conversions are done since the input source code should not have those features otherwise it would have already failed

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	HDR Standard Blue Diamond header for procedure files.

Fields inherited from class com.goldencode.p2j.e4gl.BaseHelper

entities, opts, unsafe

Fields inherited from interface com.goldencode.p2j.e4gl.CompatibilityHelper

NEWLINE

Constructor Summary

Constructors

Constructor and Description
BlueDiamondHelper()

Method Summary

Modifier and Type	Method and Description
java.lang.String	closeComment(boolean expr) Return the text used to end a comment that removes the start or end tag for a statement or expression escape.
java.lang.String	closeExprEscape() Return the text used to end the output of an embedded 4GL expression.
java.lang.String	footer() Return the text for the footer of the generated file.
java.lang.String	header() Return the text for the header of the generated file.
void	initialize(Options opts) Provides the known configuration to the helper and allows it to prepare for use.
java.lang.String	openComment(boolean expr) Return the text used to start a comment that removes the start or end tag for a statement or expression escape.
java.lang.String	openExprEscape() Return the text used to start the output of an embedded 4GL expression.
java.lang.String	openHTML(boolean content) Return the text used to start a line of raw HTML output.
java.lang.String	suffix() Return the filename suffix (extension) to be used.

Methods inherited from class com.goldencode.p2j.e4gl.BaseHelper

closeContentTypeComment, closeHTML, entityConvert, escapeHTML, openContentTypeComment, replace

Methods inherited from class java.lang.Object

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

Field Detail

HDR

private static final java.lang.String HDR

Standard Blue Diamond header for procedure files.

Constructor Detail

BlueDiamondHelper

public BlueDiamondHelper()

Method Detail

initialize

public void initialize(Options opts)

Provides the known configuration to the helper and allows it to prepare for use. This must be called before any other method can be used.

Specified by:

initialize in interface CompatibilityHelper

Overrides:

initialize in class BaseHelper

Parameters:

opts - The configuration.

suffix

public java.lang.String suffix()

Return the filename suffix (extension) to be used.

Specified by:

suffix in interface CompatibilityHelper

Overrides:

suffix in class BaseHelper

Returns:

The filename extension to use based on the known options.

header

public java.lang.String header()

Return the text for the header of the generated file. This is output before any parsed content.

Specified by:

header in interface CompatibilityHelper

Overrides:

header in class BaseHelper

Returns:

The text to use based on the known options.

openHTML

public java.lang.String openHTML(boolean content)

Return the text used to start a line of raw HTML output.

Specified by:

openHTML in interface CompatibilityHelper

Overrides:

openHTML in class BaseHelper

Parameters:

content - true if there is HTML content that is about to be emitted on the line, false to handle the no content case (just start the line, without any content prefix text).

Returns:

The text to use based on the known options.

openExprEscape

public java.lang.String openExprEscape()

Return the text used to start the output of an embedded 4GL expression.

Specified by:

openExprEscape in interface CompatibilityHelper

Overrides:

openExprEscape in class BaseHelper

Returns:

The text to use based on the known options.

closeExprEscape

public java.lang.String closeExprEscape()

Return the text used to end the output of an embedded 4GL expression.

Specified by:

closeExprEscape in interface CompatibilityHelper

Overrides:

closeExprEscape in class BaseHelper

Returns:

The text to use based on the known options.

openComment

public java.lang.String openComment(boolean expr)

Return the text used to start a comment that removes the start or end tag for a statement or expression escape.

Specified by:

openComment in interface CompatibilityHelper

Overrides:

openComment in class BaseHelper

Parameters:

expr - true if this is an expression escape, false for a statement escape.

Returns:

The text to use based on the known options. null if the escape should be removed instead of commented.

closeComment

public java.lang.String closeComment(boolean expr)

Return the text used to end a comment that removes the start or end tag for a statement or expression escape.

Specified by:

closeComment in interface CompatibilityHelper

Overrides:

closeComment in class BaseHelper

Parameters:

expr - true if this is an expression escape, false for a statement escape.

Returns:

The text to use based on the known options. null if the escape should be removed instead of commented.

footer

public java.lang.String footer()

Return the text for the footer of the generated file. This is output after all parsed content.

Specified by:

footer in interface CompatibilityHelper

Overrides:

footer in class BaseHelper

Returns:

The text to use based on the known options.