net.exegetic.markout.patterns
Interface FreeLinkPattern

All Known Implementing Classes:
AbstractFreeLinkPattern, CategoryPattern, DocPattern, ImagePattern, WikiWordPattern

public interface FreeLinkPattern

A kind of free link, and the url pattern into which name of the free link should be placed. Any occurance of the substring [[RESOURCE_NAME]] will be replaced with the name of the free link. For example, for the pattern /docs/[[RESOURCE_NAME]].html, the [[hello]] free link will be rendered as /docs/hello.html

Author:
Nathan Winant

Method Summary
 java.lang.String getMarkdownReplacementPattern()
          Returns the replacement pattern, wrapped in Markout.
 java.lang.String getMatcherPattern()
          Returns the matcher patten.
 java.lang.String getReplacementPattern()
          Returns the replacement pattern.
 void setReplacementPattern(java.lang.String replacementPattern)
          Sets the replacement pattern.
 

Method Detail

setReplacementPattern

void setReplacementPattern(java.lang.String replacementPattern)
Sets the replacement pattern. This is the url pattern that the value of the free link will be placed into,. For example: /docs/[[RESOURCE_NAME]].html.

Parameters:
replacementPattern - Replacement pattern

getMatcherPattern

java.lang.String getMatcherPattern()
Returns the matcher patten. This is the pattern that defines this kind of free link. It is the entire pattern, including the double brackets ([[]]).

Returns:
Matcher pattern

getReplacementPattern

java.lang.String getReplacementPattern()
Returns the replacement pattern. The replacement pattern as defined by the user.

Returns:
Replacement pattern

getMarkdownReplacementPattern

java.lang.String getMarkdownReplacementPattern()
Returns the replacement pattern, wrapped in Markout.

Returns:
Replacement pattern, wrapped in Markout.


Copyright © 2007 das markout Projekt. All Rights Reserved.