| java.lang.Object
 org.jamwiki.parser.AbstractParser
org.jamwiki.parser.jflex.JFlexParser
All known Subclasses: org.jamwiki.parser.bliki.BlikiParser,
| Field Summary | |
| final protected static int | MODE_LAYOUT
Layout mode indicates that the pre-processor, processor and post-processor should be run in full, parsing all Wiki syntax into formatted output and adding layout tags such as paragraphs. | | final protected static int | MODE_MINIMAL
Minimal mode is used to do a bare minimum of parsing, usually just converting signature tags, prior to saving to the database. | | final protected static int | MODE_PREPROCESS
Pre-process mode is currently equivalent to metadata mode and indicates that that the JFlex pre-processor parser should be run in full. | | final protected static int | MODE_PROCESS
Processing mode indicates that the pre-processor and processor should be run in full, parsing all Wiki syntax into formatted output. | | final protected static int | MODE_SLICE
Slice mode is used when retrieving a section of a topic for editing. | | final protected static int | MODE_SPLICE
Splice mode is used when inserting an edited topic section back into the full topic content. |
| Constructor Summary | |
| public | JFlexParser(ParserInput parserInput)
The constructor creates a parser instance, initialized with the
specified parser input settings. |
| Method Summary | |
| public String | buildRedirectContent(String topicName)
Return a parser-specific value that can be used as the content of a
topic representing a redirect. | | public String | parseFragment(ParserOutput parserOutput, String raw, int mode)
This method parses content, performing all transformations except for
layout changes such as adding paragraph tags. | | public String | parseHTML(ParserOutput parserOutput, String raw)
Returns a HTML representation of the given wiki raw text for online representation.
Parameters:
parserOutput - A ParserOutput object containing parsermetadata output.
Parameters:
raw - The raw Wiki syntax to be converted into HTML. | | public void | parseMetadata(ParserOutput parserOutput, String raw)
This method provides a way to parse content and set all output metadata,
such as link values used by the search engine. | | public String | parseMinimal(String raw)
Perform a bare minimum of parsing as required prior to saving a topic
to the database. | | public String | parseSlice(ParserOutput parserOutput, String raw, int targetSection)
This method provides the capability for retrieving a section of Wiki markup
from an existing document. | | public String | parseSplice(ParserOutput parserOutput, String raw, int targetSection, String replacementText)
This method provides the capability for splicing a section of new content back
into a document. |
| MODE_LAYOUT | | final protected static int MODE_LAYOUT(Code) | | Layout mode indicates that the pre-processor, processor and post-processor should be run in full, parsing all Wiki syntax into formatted output and adding layout tags such as paragraphs.
|
| MODE_MINIMAL | | final protected static int MODE_MINIMAL(Code) | | Minimal mode is used to do a bare minimum of parsing, usually just converting signature tags, prior to saving to the database.
|
| MODE_PREPROCESS | | final protected static int MODE_PREPROCESS(Code) | | Pre-process mode is currently equivalent to metadata mode and indicates that that the JFlex pre-processor parser should be run in full.
|
| MODE_PROCESS | | final protected static int MODE_PROCESS(Code) | | Processing mode indicates that the pre-processor and processor should be run in full, parsing all Wiki syntax into formatted output.
|
| MODE_SLICE | | final protected static int MODE_SLICE(Code) | | Slice mode is used when retrieving a section of a topic for editing.
|
| MODE_SPLICE | | final protected static int MODE_SPLICE(Code) | | Splice mode is used when inserting an edited topic section back into the full topic content.
|
| JFlexParser | | public JFlexParser(ParserInput parserInput)(Code) | | The constructor creates a parser instance, initialized with the
specified parser input settings.
Parameters:
parserInput - Input configuration settings for this parserinstance. |
| buildRedirectContent | | public String buildRedirectContent(String topicName)(Code) | | Return a parser-specific value that can be used as the content of a
topic representing a redirect. For the Mediawiki syntax parser the
value returned would be of the form "#REDIRECT [[Topic]]".
Parameters:
topicName - The name of the topic to redirect to. A parser-specific value that can be used as the content of atopic representing a redirect. |
| parseFragment | | public String parseFragment(ParserOutput parserOutput, String raw, int mode) throws Exception(Code) | | This method parses content, performing all transformations except for
layout changes such as adding paragraph tags. It is suitable to be used
when parsing the contents of a link or performing similar internal
manipulation.
Parameters:
parserOutput - A ParserOutput object containing parsermetadata output.
Parameters:
raw - The raw Wiki syntax to be converted into HTML.
Parameters:
mode - The parser mode to use when parsing. Mode affects whattype of parsing actions are taken when processing raw text. The parsed content.
throws:
Exception - Thrown if any error occurs during parsing. |
| parseHTML | | public String parseHTML(ParserOutput parserOutput, String raw) throws Exception(Code) | | Returns a HTML representation of the given wiki raw text for online representation.
Parameters:
parserOutput - A ParserOutput object containing parsermetadata output.
Parameters:
raw - The raw Wiki syntax to be converted into HTML. The parsed content.
throws:
Exception - Thrown if any error occurs during parsing. |
| parseMetadata | | public void parseMetadata(ParserOutput parserOutput, String raw) throws Exception(Code) | | This method provides a way to parse content and set all output metadata,
such as link values used by the search engine.
A ParserOutput object containing results of the parsing process.
Parameters:
raw - The raw Wiki syntax to be converted into HTML. |
| parseMinimal | | public String parseMinimal(String raw) throws Exception(Code) | | Perform a bare minimum of parsing as required prior to saving a topic
to the database. In general this method will simply parse signature
tags are return.
Parameters:
raw - The raw Wiki syntax to be converted into HTML. The parsed content.
throws:
Exception - Thrown if any error occurs during parsing. |
| parseSlice | | public String parseSlice(ParserOutput parserOutput, String raw, int targetSection) throws Exception(Code) | | This method provides the capability for retrieving a section of Wiki markup
from an existing document. It is used primarily when editing a section of
a topic. This method will return all content from the specified section, up
to the either the next section of the same or greater level or the end of the
document. For example, if the specified section is an <h3>, all content
up to the next <h1>, <h2>, <h3> or the end of the document
will be returned.
Parameters:
parserOutput - A ParserOutput object containing parsermetadata output.
Parameters:
raw - The raw Wiki text that is to be parsed.
Parameters:
targetSection - The section (counted from zero) that is to be returned. Returns the raw topic content for the target section.
throws:
Exception - Thrown if any error occurs during parsing. |
| parseSplice | | public String parseSplice(ParserOutput parserOutput, String raw, int targetSection, String replacementText) throws Exception(Code) | | This method provides the capability for splicing a section of new content back
into a document. It is used primarily when editing a section of a topic. This
method will replace all content in a specified section, up to the either the next
section of the same or greater level or the end of the document. For example, if
the specified section is an <h3>, all content up to the next <h1>,
<h2>, <h3> or the end of the document will be replaced with the
specified text.
Parameters:
parserOutput - A ParserOutput object containing parsermetadata output.
Parameters:
raw - The raw Wiki text that is to be parsed.
Parameters:
targetSection - The section (counted from zero) that is to be returned.
Parameters:
replacementText - The text to replace the target section text with. The raw topic content including the new replacement text.
throws:
Exception - Thrown if any error occurs during parsing. |
|
|