votorola.a.position

Class ComponentPipeRevisionL

java.lang.Object

PageRevision1

ComponentPipeRevision

ComponentPipeRevisionL

All Implemented Interfaces:

Serializable, CoreRevision, PageRevision, PipeRevision, PositionalRevision

@ThreadSafe
public final class ComponentPipeRevisionL
extends ComponentPipeRevision

A component pipe revision constructed nominally for the latest revision, not for a specific draft revision path.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ComponentPipeRevision

ComponentPipeRevision.MalformedContent

Nested classes/interfaces inherited from interface CoreRevision

CoreRevision.U

Field Summary

Fields inherited from class ComponentPipeRevision

TEMPLATE_CALL_PATTERN

Constructor Summary

Constructors

Constructor and Description
ComponentPipeRevisionL(PollwikiVS wiki, int _pageID, String _pageName, int _rev, int _revLatest, String _nomineeName, String _personName, String pollName) Partially constructs a ComponentPipeRevisionL for init, or init1 and init2 to finish.

Method Summary

Methods

Modifier and Type	Method and Description
List<Integer>	addDraftRevisionPath(List<Integer> path) Adds to the list the revision path from this core revision (inclusive) to the terminal draft (inclusive).
CoreRevision	candidateVariant() The core of the position this pipe is voting for as resolved from the candidate variant name, or null if no candidate variant name was set during construction.
String	candidateVariantName() The page name of the candidate's position core including the namespace, or null if this information is unknown or not required.
CoreRevision	contextView(String contextPersonName) Constructs a view of this core revision suited for viewing in the context of the specified person, or returns this same (==) core revision if it is already suited.
DraftRevision	draft() The position draft.
void	init(PollwikiVS wiki, String contextPersonName, CountSource countSource) Finishes the construction of this CoreRevision and sets isFullyConstructed true.
void	init1(PollwikiVS wiki, String contextPersonName, CountSource countSource) Continues the construction of this ComponentPipeRevisionL by setting the candidate variant name if it is not already set and the proposed pairing appears to require it.
static List<Throwable>	init2(List<ComponentPipeRevisionL> components, PollwikiVS wiki, List<Throwable> userXList, boolean toContinue) Finishes the construction of the specifed component pipe revisions and sets isFullyConstructed true for each.
boolean	isFullyConstructed() Answers whether the construction of this CoreRevision is complete.
CoreRevision	wildVariant() The wild variant indicated by this component pipe.
String	wildVariantName() The page name of the wild variant including the namespace.

Methods inherited from class ComponentPipeRevision

nominee, person, pollName

Methods inherited from class PageRevision1

equals, isLatestRevision, pageID, pageName, pageURI, readPageRevision, rev, revLatest, revURI, toString, wikiScriptURI

Methods inherited from class java.lang.Object

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

Methods inherited from interface PageRevision

isLatestRevision, pageID, pageName, pageURI, rev, revLatest, revURI, wikiScriptURI

Constructor Detail

ComponentPipeRevisionL

ComponentPipeRevisionL(PollwikiVS wiki,
                      int _pageID,
                      String _pageName,
                      int _rev,
                      int _revLatest,
                      String _nomineeName,
                      String _personName,
                      String pollName)
                 throws ComponentPipeRevision.MalformedContent

Partially constructs a ComponentPipeRevisionL for init, or init1 and init2 to finish.

Parameters:

_pageName - will be normalized for the pageName.

Throws:

ComponentPipeRevision.MalformedContent

See Also:

PageRevision1.pageID(), PageRevision1.rev(), PageRevision1.revLatest(), ComponentPipeRevision.nominee(), ComponentPipeRevision.person(), ComponentPipeRevision.pollName()

Method Detail

init

@ThreadRestricted(value="constructor")
public void init(PollwikiVS wiki,
                              String contextPersonName,
                              CountSource countSource)
          throws IOException

Finishes the construction of this CoreRevision and sets isFullyConstructed true. Call either this method, or init1 and init2, not both.

contextPersonName - the name of the person from whose viewpoint the revision will be viewed (context person), or null if there is no context person.

countSource - for possible use during this call. It is never used if there is no context person.

Throws:

IOException

init1

@ThreadRestricted(value="constructor")
public void init1(PollwikiVS wiki,
                               String contextPersonName,
                               CountSource countSource)
           throws IOException

Continues the construction of this ComponentPipeRevisionL by setting the candidate variant name if it is not already set and the proposed pairing appears to require it. This method may be called multiple times. Call either init, or this method and init2, not both.

Parameters:

contextPersonName - the name of a person from whose viewpoint this revision will eventually be viewed.

countSource - for possible use during this call.

Throws:

IOException

init2

@ThreadRestricted(value="constructor")
public static List<Throwable> init2(List<ComponentPipeRevisionL> components,
                                          PollwikiVS wiki,
                                          List<Throwable> userXList,
                                          boolean toContinue)
                             throws IOException

Finishes the construction of the specifed component pipe revisions and sets isFullyConstructed true for each. Call either init, or init1 and this method, not both.

Parameters:

components - the list of partially constructed component pipe revisions.

userXList - a pre-constructed list to which any user actionable exceptions are to be appended, or null if none was pre-constructed. Provide ENLIST_NONE to instead force the immediate throwing of such exceptions.

toContinue - whether to continue in the event of a missing wild variant and to leave the incompletely constructed component pipe revision as is (true), or to throw a NoSuchPage exception (false).

Returns:

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

Throws:

IllegalStateException - if called a second time for a given component pipe revision.

MediaWiki.NoSuchPage - if toContinue is false and a wild variant is missing.

IOException

candidateVariant

public CoreRevision candidateVariant()

The core of the position this pipe is voting for as resolved from the candidate variant name, or null if no candidate variant name was set during construction.

candidateVariantName

public String candidateVariantName()

The page name of the candidate's position core including the namespace, or null if this information is unknown or not required. It is required only if this component pipe revision will be viewed from the context of its own wild variant, among other possible views.

See Also:

init1(PollwikiVS,String,CountSource)

wildVariant

public CoreRevision wildVariant()

The wild variant indicated by this component pipe.

wildVariantName

public String wildVariantName()

The page name of the wild variant including the namespace.

addDraftRevisionPath

public List<Integer> addDraftRevisionPath(List<Integer> path)

Description copied from interface: CoreRevision

Adds to the list the revision path from this core revision (inclusive) to the terminal draft (inclusive).

Returns:

the same list.

contextView

public CoreRevision contextView(String contextPersonName)

Description copied from interface: CoreRevision

Constructs a view of this core revision suited for viewing in the context of the specified person, or returns this same (==) core revision if it is already suited.

draft

public DraftRevision draft()

Description copied from interface: CoreRevision

The position draft. This may be null if the revision is incompletely constructed.

isFullyConstructed

public boolean isFullyConstructed()

Description copied from interface: CoreRevision

Answers whether the construction of this CoreRevision is complete.

See Also:

init1(PollwikiVS,String,CountSource), init2(List,PollwikiVS,List,boolean)