votorola.a.diff

Class DraftPair

java.lang.Object

DraftPair

All Implemented Interfaces:

Serializable

@ThreadSafe
public final class DraftPair
extends Object
implements Serializable

A pair of draft revisions for differencing.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	DraftPair.MalformedContent Thrown when a request cannot be met because the content of a page is not in the required form.
(package private) static class	DraftPair.MalformedSpecifier Thrown when a request cannot be met because the specifier of a draft pair is not in the required form.
(package private) static class	DraftPair.PathMismatch Thrown when a request cannot be met because an actual draft revision path is inconsistent with the expected path.
(package private) static class	DraftPair.RevisionSeriesMismatch Thrown when a request cannot be met because the revision series of the difference key no longer matches that of the pollwiki.

Method Summary

Methods

Modifier and Type	Method and Description
CoreRevision	aCore() The core revision of the a-draft.
String	aUserMnemonic() A short abbreviation of the username of the first draft's author.
CoreRevision	bCore() The core revision of the b-draft.
String	bUserMnemonic() A short abbreviation of the username of the second draft's author.
DiffKeyParse	diffKeyParse() The difference key of this draft pair.
static DraftPair	newDraftPair(DiffKeyParse diffKeyParse, PollwikiVS wiki) Constructs a DraftPair from a parsed difference key.
static DraftPair	newDraftPair(String pageName1, String pageName2, VoteServer.Run vsRun, CountSource countSource) Constructs a DraftPair from the latest revisions of the specified position cores.
static List<Throwable>	newDraftPairs(ArrayList<String> aPageNameList, String bPageName, VoteServer.Run vsRun, CountSource countSource, List<DraftPair> pairs, List<Throwable> userXList) Constructs a DraftPair for the latest of each of the specified position cores that resolves to a draft (aPageNameList) and appends it to the provided list of pairs.
DraftPair	newReversePair() Constructs the reverse of this draft pair, in which all components of a-draft and b-draft are interchanged.

Methods inherited from class java.lang.Object

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

Method Detail

newDraftPair

public static DraftPair newDraftPair(DiffKeyParse diffKeyParse,
                     PollwikiVS wiki)
                              throws IOException

Constructs a DraftPair from a parsed difference key.

Throws:

IOException

See Also:

diffKeyParse()

newDraftPair

public static DraftPair newDraftPair(String pageName1,
                     String pageName2,
                     VoteServer.Run vsRun,
                     CountSource countSource)
                              throws IOException

Constructs a DraftPair from the latest revisions of the specified position cores. The order of drafts in the resulting pair (aDraft, bDraft) will be lexical by author name regardless of the order of actual parameters (pageName1, pageName2).

Parameters:

countSource - for possible use during this call, or null to construct one internally.

Throws:

IOException

newDraftPairs

public static List<Throwable> newDraftPairs(ArrayList<String> aPageNameList,
                            String bPageName,
                            VoteServer.Run vsRun,
                            CountSource countSource,
                            List<DraftPair> pairs,
                            List<Throwable> userXList)
                                     throws IOException

Constructs a DraftPair for the latest of each of the specified position cores that resolves to a draft (aPageNameList) and appends it to the provided list of pairs. Uses the latest of bPageName as the second core in each pair. Appends the pairs in an unspecified order that might not correspond to the order of elements in aPageNameList.

Parameters:

aPageNameList - the name list of first (a) core pages, ideally with spare capacity to append one additional name. Duplicate names will not result in duplicate pairs because the MediaWiki API collapses them to one.

countSource - for possible use during this call, or null to construct one internally.

userXList - a pre-constructed list to which any user actionable exceptions are to be appended, or null if none was pre-constructed.

Returns:

the same userXList if there was one; otherwise null if no exceptions were encountered; otherwise a newly constructed list.

Throws:

IOException

aCore

public CoreRevision aCore()

The core revision of the a-draft.

aUserMnemonic

public String aUserMnemonic()

A short abbreviation of the username of the first draft's author.

bCore

public CoreRevision bCore()

The core revision of the b-draft.

bUserMnemonic

public String bUserMnemonic()

A short abbreviation of the username of the second draft's author.

diffKeyParse

public DiffKeyParse diffKeyParse()

The difference key of this draft pair.

newReversePair

public DraftPair newReversePair()

Constructs the reverse of this draft pair, in which all components of a-draft and b-draft are interchanged.