BaseHelper (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.e4gl.BaseHelper

All Implemented Interfaces:

CompatibilityHelper

Direct Known Subclasses:

BlueDiamondHelper, WebSpeedHelper
```
public class BaseHelper
extends java.lang.Object
implements CompatibilityHelper
```
Provides common compatibility helper features. This class is a complete, working implementation of the compatibility interface. However, it does not define full compatibility with any of the known implementations.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Map<java.lang.String,java.lang.String>`	`entities` Replacement mappings for removing HTML entities.
`protected Options`	`opts` Configuration to be honored.
`protected java.util.Map<java.lang.String,java.lang.String>`	`unsafe` Replacement mappings for escaping unsafe HTML characters.

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

Constructor Summary

Constructors
Constructor and Description

BaseHelper()

Constructors
Constructor and Description
`BaseHelper()`

Method Summary

All Methods Instance Methods Concrete Methods
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`	`closeContentTypeComment()` Return the text used to end a comment that removes the META or WSMETA element with an HTTP-EQUIV attribute that is set to CONTENT-TYPE.
`java.lang.String`	`closeExprEscape()` Return the text used to end the output of an embedded 4GL expression.
`java.lang.String`	`closeHTML(boolean content)` Return the text used to end a line of raw HTML output.
`java.lang.String`	`entityConvert(java.lang.String e4gl)` Convert any HTML entities (in the given E4GL text) into the equivalent characters.
`java.lang.String`	`escapeHTML(java.lang.String html)` Convert any unsafe characters (in the given HTML text) into equivalents that are safe to embed in a 4GL string literal and return that converted text.
`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`	`openContentTypeComment()` Return the text used to start a comment that removes the META or WSMETA element with an HTTP-EQUIV attribute that is set to CONTENT-TYPE.
`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.
`protected java.lang.String`	`replace(java.util.Map<java.lang.String,java.lang.String> replace, java.lang.String txt)` Use the mapped keys to convert any matching characters (in the given text) into the equivalent mapped value.
`java.lang.String`	`suffix()` Return the filename suffix (extension) to be used.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - opts
```
protected Options opts
```
    Configuration to be honored.
  - unsafe
```
protected java.util.Map<java.lang.String,java.lang.String> unsafe
```
    Replacement mappings for escaping unsafe HTML characters.
  - entities
```
protected java.util.Map<java.lang.String,java.lang.String> entities
```
    Replacement mappings for removing HTML entities.
- Constructor Detail
  - BaseHelper
```
public BaseHelper()
```
- 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
    
    Parameters:
    
    opts - The configuration.
  - suffix
```
public java.lang.String suffix()
```
    Return the filename suffix (extension) to be used.
    
    Specified by:
    
    suffix in interface CompatibilityHelper
    
    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
    
    Returns:
    
    Always the empty string.
  - 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
    
    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.
  - closeHTML
```
public java.lang.String closeHTML(boolean content)
```
    Return the text used to end a line of raw HTML output.
    
    Specified by:
    
    closeHTML in interface CompatibilityHelper
    
    Parameters:
    
    content - true if there is content that needs to be finished on the line, false to handle the no content case (just terminate the line, without any content termination text).
    
    Returns:
    
    The text to use based on the known options.
  - escapeHTML
```
public java.lang.String escapeHTML(java.lang.String html)
```
    Convert any unsafe characters (in the given HTML text) into equivalents that are safe to embed in a 4GL string literal and return that converted text.
    
    Specified by:
    
    escapeHTML in interface CompatibilityHelper
    
    Returns:
    
    The replacement text.
  - entityConvert
```
public java.lang.String entityConvert(java.lang.String e4gl)
```
    Convert any HTML entities (in the given E4GL text) into the equivalent characters.
    
    Specified by:
    
    entityConvert in interface CompatibilityHelper
    
    Returns:
    
    The replacement text with all conversion applied.
  - 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
    
    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
    
    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
    
    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
    
    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.
  - openContentTypeComment
```
public java.lang.String openContentTypeComment()
```
    Return the text used to start a comment that removes the META or WSMETA element with an HTTP-EQUIV attribute that is set to CONTENT-TYPE.
    
    Specified by:
    
    openContentTypeComment in interface CompatibilityHelper
    
    Returns:
    
    The text to use based on the known options. Return the empty string if the element should be left behind instead of commented.
  - closeContentTypeComment
```
public java.lang.String closeContentTypeComment()
```
    Return the text used to end a comment that removes the META or WSMETA element with an HTTP-EQUIV attribute that is set to CONTENT-TYPE.
    
    Specified by:
    
    closeContentTypeComment in interface CompatibilityHelper
    
    Returns:
    
    The text to use based on the known options. Return the empty string if the element should be left behind 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
    
    Returns:
    
    Always the empty string.
  - replace
```
protected java.lang.String replace(java.util.Map<java.lang.String,java.lang.String> replace,
                                   java.lang.String txt)
```
    Use the mapped keys to convert any matching characters (in the given text) into the equivalent mapped value. Then return that converted text.
    
    Returns:
    
    The replacement text.

Class BaseHelper

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

opts

unsafe

entities

Constructor Detail

BaseHelper

Method Detail

initialize

suffix

header

openHTML

closeHTML

escapeHTML

entityConvert

openExprEscape

closeExprEscape

openComment

closeComment

openContentTypeComment

closeContentTypeComment

footer

replace