| java.lang.Object
 org.jamwiki.parser.ParserOutput
| ParserOutput | | public class ParserOutput implements Serializable(Code) | | This class represents the output from the JAMWiki parser. It holds parsed
output text as well as metadata that is generated by the parser.
|
| Method Summary | |
| public void | addCategory(String categoryName, String sortKey)
When a document contains a token indicating that the document belongs
to a specific category this method should be called to add that
category to the output metadata.
Parameters:
categoryName - The name of the category that the document belongsto.
Parameters:
sortKey - The sort key for the category, or null ifno sort key has been specified. | | public void | addLink(String topicName)
When a document contains a token indicating that the document links
to another Wiki topic this method should be called to add that
topic link to the output metadata. | | public void | addTemplate(String template)
When a document contains a token indicating that the document includes
a Wiki template this method should be called to add that template
to the output metadata. | | public void | appendMetadata(ParserOutput document)
| | public boolean | getCacheable()
Return a flag indicating whether or not the current ParserOutput
object can be cached. | | public LinkedHashMap | getCategories()
Return the current mapping of categories associated with the document
being parsed. | | public Vector | getLinks()
For the document being parsed, return the current collection of topic
names for all topics that are linked to from the current document. | | public String | getRedirect()
If a document being parsed represents a redirect, return the name of
the topic that this document redirects to. | | public String | getSectionName()
When editing or parsing a section of a document, get the name of
the heading for that section.
The name of the heading for a section of a document beingparsed, or null if a section is not being parsed. | | public Vector | getTemplates()
For the document being parsed, return the current collection of
templates names for all templates that are included in the current
document. | | public void | setCacheable(boolean cacheable)
Sets a flag indicating whether or not the current ParserOutput
object can be cached. | | public void | setRedirect(String redirect)
If a document being parsed represents a redirect, set the name of
the topic that this document redirects to. | | public void | setSectionName(String sectionName)
When editing or parsing a section of a document, set the name of
the heading for that section. |
| ParserOutput | | public ParserOutput()(Code) | | |
| addCategory | | public void addCategory(String categoryName, String sortKey)(Code) | | When a document contains a token indicating that the document belongs
to a specific category this method should be called to add that
category to the output metadata.
Parameters:
categoryName - The name of the category that the document belongsto.
Parameters:
sortKey - The sort key for the category, or null ifno sort key has been specified. The sort key determines what ordercategories are sorted on category index pages, so a category for"John Doe" might be given a sort key of "Doe, John". |
| addLink | | public void addLink(String topicName)(Code) | | When a document contains a token indicating that the document links
to another Wiki topic this method should be called to add that
topic link to the output metadata.
Parameters:
topicName - The name of the topic that is linked to. |
| addTemplate | | public void addTemplate(String template)(Code) | | When a document contains a token indicating that the document includes
a Wiki template this method should be called to add that template
to the output metadata.
Parameters:
template - The name of the template that is being included. |
| getCacheable | | public boolean getCacheable()(Code) | | Return a flag indicating whether or not the current ParserOutput
object can be cached. If the document contains user-specific,
time-specific or other non-cacheable content then this method should
return false.
true if the current ParserOutput is cacheable,false if it contains any non-cacheable content. |
| getCategories | | public LinkedHashMap getCategories()(Code) | | Return the current mapping of categories associated with the document
being parsed. The mapping contains key-value pairs with the category
name as the key and the sort key (if any) as the value.
A mapping of categories and their associated sort keys (if any)for all categories that are associated with the document being parsed. |
| getLinks | | public Vector getLinks()(Code) | | For the document being parsed, return the current collection of topic
names for all topics that are linked to from the current document.
A collection of all topic names that are linked to from thecurrent document. |
| getRedirect | | public String getRedirect()(Code) | | If a document being parsed represents a redirect, return the name of
the topic that this document redirects to.
The name of the topic that this document redirects to, ornull if the document does not represent a redirect. |
| getSectionName | | public String getSectionName()(Code) | | When editing or parsing a section of a document, get the name of
the heading for that section.
The name of the heading for a section of a document beingparsed, or null if a section is not being parsed. If notnull then the section name should be encoded for use in aURL. |
| getTemplates | | public Vector getTemplates()(Code) | | For the document being parsed, return the current collection of
templates names for all templates that are included in the current
document.
A collection of all template names that are included in thecurrent document. |
| setCacheable | | public void setCacheable(boolean cacheable)(Code) | | Sets a flag indicating whether or not the current ParserOutput
object can be cached. If the document contains user-specific,
time-specific or other non-cacheable content then the cacheable flag
should be set to false.
Parameters:
cacheable - Set to true if the current ParserOutputis cacheable, false if it contains any non-cacheablecontent. |
| setRedirect | | public void setRedirect(String redirect)(Code) | | If a document being parsed represents a redirect, set the name of
the topic that this document redirects to.
Parameters:
redirect - The name of the topic that this document redirects to,or null if the document does not represent a redirect. |
| setSectionName | | public void setSectionName(String sectionName)(Code) | | When editing or parsing a section of a document, set the name of
the heading for that section.
Parameters:
sectionName - The name of the heading for a section of a documentbeing parsed, or null if a section is not being parsed.If not null then the section name should be encoded foruse in a URL. |
|
|