votorola.a.diff

Class LineTransformer1

java.lang.Object

LineTransformer1

@ThreadSafe
public final class LineTransformer1
extends Object

A bidirectional transformer of wikitext lines, that breaks incoming wikitext into multiple lines at punctuation marks. Lines thus broken are marked by an appended soft-break character. We need this because diff/patch tools are line oriented, depending on newline characters for context; wheras wikitext is typically paragraph-oriented and has very long lines.

Bracket markers to distinguish meta-content from proper content

The line transformer recognizes markers that distinguish meta-content from proper content. The meta-content must bracket the page like a header and footer. It is marked by lines that contain BRAC_LINE_MARKER_PATTERN. These lines and the content above or below are ignored for differencing purposes. Pages are thus structured as follows:

     The optional high bracket, or header, ends with a line
     containing this marker <!--voHiBrac-->

     The content proper for differencing purposes

     This <!--voLoBrac--> marks the first line
     of the optional low bracket, or footer.

Note that this transformer may append a final newline to outgoing wikitext that was not in the original. This is unlikely to have much effect, because MediaWiki's own editor has the same behaviour.

See Also:

Category:Draft Bracket markers

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static Pattern	BRAC_LINE_MARKER_PATTERN The pattern of a "low bracket" or "high bracket" marker in a line of wikitext.

Constructor Summary

Constructors

Constructor and Description
LineTransformer1()

Method Summary

Methods

Modifier and Type	Method and Description
(package private) void	appendFromWiki(String line, Writer out) Appends a line of incoming text from the wiki.
void	appendToWiki(String line, Writer out) Appends a line of outgoing text, destined for the wiki.
File[]	fetchPageAsFile(URI s, String idType, int id, String prefix, Spool fileSpool) Downloads the wikitext source of the specified page, and splits it into one or more temporary files.
(package private) void	test() Runs a loopback test of this line transformer.

Methods inherited from class java.lang.Object

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

Field Detail

BRAC_LINE_MARKER_PATTERN

static final Pattern BRAC_LINE_MARKER_PATTERN

The pattern of a "low bracket" or "high bracket" marker in a line of wikitext. Group (1) contains the bracket type. If it equals "Hi", then it marks the last line of the "high bracket". The high bracket (basically a header) includes all lines from the start of the page to this line. If it equals "Lo", then it marks the first line of the "low bracket". The low bracket (a footer) includes all lines form this one to the end of the page. All lines of the high and low brackets are ignored for differencing purposes.

Constructor Detail

LineTransformer1

public LineTransformer1()

Method Detail

appendFromWiki

void appendFromWiki(String line,
                  Writer out)
              throws IOException

Appends a line of incoming text from the wiki.

Throws:

IOException

appendToWiki

public void appendToWiki(String line,
                Writer out)
                  throws IOException

Appends a line of outgoing text, destined for the wiki. This undoes the incoming transformation.

Throws:

IOException

fetchPageAsFile

public File[] fetchPageAsFile(URI s,
                     String idType,
                     int id,
                     String prefix,
                     Spool fileSpool)
                       throws IOException

Downloads the wikitext source of the specified page, and splits it into one or more temporary files.

Parameters:

idType - one of "curid" or "oldid".

id - the page identifier (curid) or revision identifier (oldid).

s - the base URI for script execution in the wiki, without a trailing slash (/).

prefix - the base prefix for the temporary files.

fileSpool - the spool to hold temporary files. If unwound, the files will be deleted.

Returns:

an array of up to three files: [0] a file containing the transformed content of the high bracket up to and including BRAC_LINE_MARKER_PATTERN (Hi), or null if there is none; [1] a file containing the transformed main body of the source text; and [2] a file containing the untransformed low bracket, up to and including BRAC_LINE_MARKER_PATTERN (Lo), or null if there is none. Note that only the low bracket file is untransformed.

Throws:

IOException

See Also:

www.mediawiki.org/wiki/Manual:Parameters_to_index.php

test

void test()
    throws IOException

Runs a loopback test of this line transformer.

Throws:

IOException