votorola.a.position

Class PageRevision1

java.lang.Object

PageRevision1

All Implemented Interfaces:

Serializable, PageRevision

Direct Known Subclasses:

ComponentPipeRevision, LocalDraftRevision, PointerRevision, RemoteDraftRevision

@ThreadSafe
public class PageRevision1
extends Object
implements PageRevision

An implementation of a page revision.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PageRevision1(PageRevision rP) Constructs a PageRevision1 as a copy of another instance of a page revision.
protected	PageRevision1(URI _wikiScriptURI, int _pageID, String _pageName, int _rev, int _revLatest, String wikiLocation, boolean maybeUgly) Constructs a PageRevision1.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o) Returns true iff o is a PageRevision having the same (equals) wiki script location and revision identifier.
boolean	isLatestRevision() Returns true iff rev() == revLatest().
int	pageID() The page identifier.
String	pageName() The name of the page including the namespace.
URI	pageURI() The location of the page non-specific to any particular revision.
static PageRevision	readPageRevision(URI wikiScriptURI, XMLStreamReader _xml, boolean _toLatest) Attempts to construct a PageRevision1 from the response to a page query.
int	rev() The revision identifier.
int	revLatest() The revision identifier of the latest page revision.
URI	revURI() The location of the revision.
String	toString() Returns "r.
URI	wikiScriptURI() The base location for script execution in the containing wiki, without a trailing slash (/).

Methods inherited from class java.lang.Object

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

Constructor Detail

PageRevision1

protected PageRevision1(URI _wikiScriptURI,
             int _pageID,
             String _pageName,
             int _rev,
             int _revLatest,
             String wikiLocation,
             boolean maybeUgly)

Constructs a PageRevision1.

Parameters:

_pageName - it will be normalized.

maybeUgly - whether the wiki location might be the standard access location ending in "index.php" for example, or is definitely a pretty alias per $wgUsePathInfo.

See Also:

wikiScriptURI(), pageID(), rev(), revLatest()

PageRevision1

protected PageRevision1(PageRevision rP)

Constructs a PageRevision1 as a copy of another instance of a page revision.

Method Detail

readPageRevision

public static PageRevision readPageRevision(URI wikiScriptURI,
                            XMLStreamReader _xml,
                            boolean _toLatest)
                                     throws IOException,
                                            XMLStreamException

Attempts to construct a PageRevision1 from the response to a page query.

Parameters:

_xml - a reader for the response to a page query that covers properties 'info' or (if !_toLatest) 'info|revisions' in which at least one 'page' element might remain to be read.

_toLatest - true to read the revision from info 'lastrevid', or false to read it from the 'revisions' that are included in the query.

Returns:

the constructed page revision, or null if no 'page' element remains to be read.

Throws:

MediaWiki.NoSuchItem - if a requested page or revision does not exist.

IOException

XMLStreamException

equals

public final boolean equals(Object o)

Returns true iff o is a PageRevision having the same (equals) wiki script location and revision identifier.

Overrides:

equals in class Object

See Also:

rev(), wikiScriptURI()

toString

public String toString()

Returns "r.rev".

Overrides:

toString in class Object

isLatestRevision

public boolean isLatestRevision()

Description copied from interface: PageRevision

Returns true iff rev() == revLatest().

Specified by:

isLatestRevision in interface PageRevision

pageID

public final int pageID()

Description copied from interface: PageRevision

The page identifier.

Specified by:

pageID in interface PageRevision

See Also:

Manual:Page_table#page_id

pageName

public final String pageName()

Description copied from interface: PageRevision

The name of the page including the namespace.

Specified by:

pageName in interface PageRevision

pageURI

public final URI pageURI()

Description copied from interface: PageRevision

The location of the page non-specific to any particular revision.

Specified by:

pageURI in interface PageRevision

See Also:

PageRevision.revURI()

rev

public final int rev()

Description copied from interface: PageRevision

The revision identifier.

Specified by:

rev in interface PageRevision

See Also:

Manual:Revision_table#rev_id

revLatest

public final int revLatest()

Description copied from interface: PageRevision

The revision identifier of the latest page revision.

Specified by:

revLatest in interface PageRevision

See Also:

Manual:Page_table#page_latest

revURI

public final URI revURI()

Description copied from interface: PageRevision

The location of the revision. It is guaranteed to end with a query component, ready for appending additional query parameters.

Specified by:

revURI in interface PageRevision

See Also:

PageRevision.pageURI()

wikiScriptURI

public final URI wikiScriptURI()

Description copied from interface: PageRevision

The base location for script execution in the containing wiki, without a trailing slash (/). For example http://reluk.ca/mediawiki. Script requests may be constructed by appending the script path and parameters:

    wikiScriptURI().toASCIIString() + "/index.php?oldid=1138"

Specified by:

wikiScriptURI in interface PageRevision