PointerRevision (Votorola Java API)

java.lang.Object
- PageRevision1
- - PointerRevision

All Implemented Interfaces:

Serializable, CoreRevision, PageRevision, PositionalRevision
```
@ThreadSafe
public final class PointerRevision
extends PageRevision1
implements CoreRevision
```
A particular revision of a draft pointer.

See Also:
Category:Draft pointer, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`(package private) static class`	`PointerRevision.MalformedContent` Thrown when a request cannot be met because the content of a page is not in the form required for a draft pointer.
`(package private) static class`	`PointerRevision.MalformedURL` Thrown when a request cannot be met because a draft pointer encodes an external link with a malformed URL.

Nested classes/interfaces inherited from interface CoreRevision
CoreRevision.U

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) static Pattern`	`EXTERNAL_LINK_PATTERN` The search pattern for an external link to a remote draft in an obsolete draft pointer page.
`(package private) static Pattern`	`TEMPLATE_CALL_PATTERN_1` The search pattern for a draft pointer template call in an obsolete draft pointer page.
`(package private) static Pattern`	`TEMPLATE_CALL_PATTERN_2` The search pattern for a draft pointer template call in a draft pointer page.

Constructor Summary

Constructors
Constructor and Description
`PointerRevision(PollwikiVS wiki, int _pageID, String _pageName, int _rev, int _revLatest, String _draftName, URI _remoteWikiURI, URI _remoteWikiScriptURI, String _content0)` Partically constructs a PointerRevision for init 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`	`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.
`RemoteDraftRevision`	`draft()` The position draft.
`String`	`draftName()` The page name of the remote draft including the namespace.
`void`	`init(PollwikiVS wiki, String _contextPersonName, CountSource _countSource)` Finishes the construction of this CoreRevision and sets isFullyConstructed true.
`void`	`init(RemoteDraftRevision _draft)` Finishes the construction of this PointerRevision and sets isFullyConstructed true.
`static void`	`initConsume(List<PointerRevision> pointers, PollwikiVS wiki, URI remoteWikiScriptURI, boolean toContinue)` Attempts to finish constructing the specifed pointer revisions by constructing their remote drafts, each to the latest revision.
`boolean`	`isFullyConstructed()` Answers whether the construction of this CoreRevision is complete.
`IDPair`	`person()` The identifier of the person who takes the position.
`String`	`pollName()` The name of the poll in which the person takes a position.
`URI`	`remoteWikiScriptURI()` The base URI for script execution in the remote wiki, without a trailing slash (/).
`boolean`	`remoteWikiURI_maybeUgly()` Answers whether the remote wiki URI might be based on the standard access URL ending in "index.php" for example, or is definitely based on an alias.
`URI`	`remoteWikiURI()` The base URI for requesting pages from the remote wiki, without a trailing slash (/).

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

- Field Detail
  - EXTERNAL_LINK_PATTERN
```
static final Pattern EXTERNAL_LINK_PATTERN
```
    The search pattern for an external link to a remote draft in an obsolete draft pointer page. If the pattern matches, it splits the name into groups (1) domain name (always "metagovernment.org") and (2) page name of remote draft encoded as a URL parameter value ("User:Joe/my_draft").
    
    See Also:
    Category:Draft_pointer&oldid=4015
  - TEMPLATE_CALL_PATTERN_1
```
static final Pattern TEMPLATE_CALL_PATTERN_1
```
    The search pattern for a draft pointer template call in an obsolete draft pointer page. If the pattern matches, it splits the name into groups based on the template parameter values (1) domain name (always "metagovernment.org") and (2) full page name of remote draft (e.g. "User:Joe/my draft").
    
    See Also:
    Category:Draft_pointer&oldid=5351
  - TEMPLATE_CALL_PATTERN_2
```
static final Pattern TEMPLATE_CALL_PATTERN_2
```
    The search pattern for a draft pointer template call in a draft pointer page. If the pattern matches, it splits the name into groups based on the template parameter values (1) full page name of remote draft (e.g. "User:Joe/my_draft") and (2) full page name of drafting site ("Stuff:Metagovernment/wiki"). This method of extracting properties from a revision is required because SemanticMediawiki's data store does not attach properties to revisions, only to pages.
    
    See Also:
    Category:Draft_pointer
- Constructor Detail
  - PointerRevision
```
PointerRevision(PollwikiVS wiki,
               int _pageID,
               String _pageName,
               int _rev,
               int _revLatest,
               String _draftName,
               URI _remoteWikiURI,
               URI _remoteWikiScriptURI,
               String _content0)
          throws PositionIDPair.MalformedPageName,
                 PipeRevision.MalformedContent
```
    Partically constructs a PointerRevision for init to finish.
    
    Parameters:
    _pageName - it will be normalized.
    _draftName - it will be normalized.
    _content0 - the wikitext of the revision including at least section 0.
    
    Throws:
    
    PositionIDPair.MalformedPageName
    
    PipeRevision.MalformedContent
    See Also:
    PageRevision1.pageID(), PageRevision1.rev(), PageRevision1.revLatest(), remoteWikiURI(), remoteWikiScriptURI()
- Method Detail
  - init
```
@ThreadRestricted(value="constructor")
public void init(RemoteDraftRevision _draft)
```
    Finishes the construction of this PointerRevision and sets isFullyConstructed true.
    
    Throws:
    
    IllegalStateException - if called a second time.
    See Also:
    draft()
  - init
```
@ThreadRestricted(value="constructor")
public void init(PollwikiVS wiki,
                              String _contextPersonName,
                              CountSource _countSource)
          throws IOException
```
    Description copied from interface: CoreRevision
    
    Finishes the construction of this CoreRevision and sets isFullyConstructed true.
    
    Specified by:
    
    init in interface CoreRevision
    
    _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
  - initConsume
```
@ThreadRestricted(value="constructor")
public static void initConsume(List<PointerRevision> pointers,
                                     PollwikiVS wiki,
                                     URI remoteWikiScriptURI,
                                     boolean toContinue)
                        throws IOException
```
    Attempts to finish constructing the specifed pointer revisions by constructing their remote drafts, each to the latest revision. Call once only for each pointer revision.
    
    Parameters:
    pointers - the list of pointer revisions from which the fully constructed ones are to be removed.
    toContinue - whether to continue in the event of a missing draft and to leave the incompletely constructed pointer in the list with a null draft (true), or to throw a NoSuchPage exception (false).
    
    Throws:
    
    MediaWiki.NoSuchPage - if toContinue is false and a remote draft is missing.
    
    IOException
  - draftName
```
public String draftName()
```
    The page name of the remote draft including the namespace.
  - remoteWikiScriptURI
```
public URI remoteWikiScriptURI()
```
    The base URI for script execution in the remote wiki, without a trailing slash (/).
    
    See Also:
    PageRevision.wikiScriptURI(), Template:Drafting site properties
  - remoteWikiURI
```
public URI remoteWikiURI()
```
    The base URI for requesting pages from the remote wiki, without a trailing slash (/). This is either the standard access URI ending in something like "index.php" for example, or an alias for it.
    
    See Also:
    Template:Drafting site properties
  - remoteWikiURI_maybeUgly
```
public boolean remoteWikiURI_maybeUgly()
```
    Answers whether the remote wiki URI might be based on the standard access URL ending in "index.php" for example, or is definitely based on an alias. In the latter case $wgUsePathInfo may be assumed true.
  - 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).
    
    Specified by:
    
    addDraftRevisionPath in interface CoreRevision
    
    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.
    
    Specified by:
    
    contextView in interface CoreRevision
  - draft
```
public RemoteDraftRevision draft()
```
    Description copied from interface: CoreRevision
    
    The position draft. This may be null if the revision is incompletely constructed.
    
    Specified by:
    
    draft in interface CoreRevision
  - isFullyConstructed
```
public boolean isFullyConstructed()
```
    Description copied from interface: CoreRevision
    
    Answers whether the construction of this CoreRevision is complete.
    
    Specified by:
    
    isFullyConstructed in interface CoreRevision
    
    See Also:
    init(RemoteDraftRevision)
  - person
```
public IDPair person()
```
    Description copied from interface: PositionalRevision
    
    The identifier of the person who takes the position.
    
    Specified by:
    
    person in interface PositionalRevision
  - pollName
```
public String pollName()
```
    Description copied from interface: PositionalRevision
    
    The name of the poll in which the person takes a position.
    
    Specified by:
    
    pollName in interface PositionalRevision
    
    See Also:
    Poll.name()

Class PointerRevision

Nested Class Summary

Nested classes/interfaces inherited from interface CoreRevision

Field Summary

Constructor Summary

Method Summary

Methods inherited from class PageRevision1

Methods inherited from class java.lang.Object

Methods inherited from interface PageRevision

Field Detail

EXTERNAL_LINK_PATTERN

TEMPLATE_CALL_PATTERN_1

TEMPLATE_CALL_PATTERN_2

Constructor Detail

PointerRevision

Method Detail

init

init

initConsume

draftName

remoteWikiScriptURI

remoteWikiURI

remoteWikiURI_maybeUgly

addDraftRevisionPath

contextView

draft

isFullyConstructed

person

pollName