votorola.a

Class PagePropertyReader

java.lang.Object

PagePropertyReader

All Implemented Interfaces:

Closeable, AutoCloseable

public final class PagePropertyReader
extends Object
implements Closeable

A reader of Semantic MediaWiki properties for a cached pollwiki page. It reads the ordinary properties of the page, as well as the special "URL" property (undocumented as of Semantic MediaWiki 1.7.1).

Constructor Summary

Constructors

Constructor and Description
PagePropertyReader(WikiCache wikiCache, String _fullPageName, PageProperty... _properties) Creates a PagePropertyReader.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Does nothing but close the underlying reader.
boolean	hasNext() Answers whether a property remains to be read.
PageProperty	read() Reads the next property from the page that matches one of those requested.
void	readAllRequested() Reads the page properties until either each of those requested has a value, or no more properties remain in the page.

Methods inherited from class java.lang.Object

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

Constructor Detail

PagePropertyReader

public PagePropertyReader(WikiCache wikiCache,
                  String _fullPageName,
                  PageProperty... _properties)
                   throws IOException

Creates a PagePropertyReader.

Parameters:

_fullPageName - the full name of the page, including any namespace.

Throws:

IOException

See Also:

properties()

Method Detail

hasNext

public boolean hasNext()

Answers whether a property remains to be read. Returns true if the page has an unread property that matches one of those requested.

read

public PageProperty read()
                  throws IOException

Reads the next property from the page that matches one of those requested. Returns the property with the value filled in from the page.

Throws:

NoSuchElementException - if no property remains to be read.

IOException

readAllRequested

public void readAllRequested()
                      throws IOException

Reads the page properties until either each of those requested has a value, or no more properties remain in the page. Use this method when all requested properties are single valued, or when you intend to ignore any additional values they might have. In the latter case, which of the multiple values is filled in by this method is undefined; viz. it is not guaranteed to be the first value.

Throws:

IOException

close

public void close()
           throws IOException

Does nothing but close the underlying reader. This reader itself need not be closed.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException