MediaWikiQuery Class Reference

A basic URL fetch class that reads the given URL into an NSData object and passes it on to it's delegate once the process has finished. More...

#import <MediaWikiQuery.h>

Inheritance diagram for MediaWikiQuery:

List of all members.

Public Member Functions
(void)	- addProgressListener:
	Adds a progress listener object to this object's listeners.
(NSString *)	- buildQueryURL
	Builds the query URL, intended to be easily re-implemented in sublcasses.
(void)	- connection:didFailWithError:
	NSURLConnection delegate method.
(void)	- connection:didReceiveData:
	NSURLConnection delegate method.
(void)	- connection:didReceiveResponse:
	NSURLConnection delegate method.
(void)	- connectionDidFinishLoading:
	NSURLConnection delegate method.
(void)	- dealloc [implementation]
(id)	- init [implementation]
	Initializes the object.
(id)	- initWithDelegate:
	Initialize a new MediaWikiQuery object with the specified delegate.
(id)	- initWithDelegate:mediaWikiURL:
	Initialize a new MediaWikiQuery object with the specified delegate and MediaWiki URL (as a string)
(void)	- removeProgressListener:
	Removes a progress listener object from this object's listeners.
(BOOL)	- startQuery
	Launches the query process.
Protected Attributes
NSURLConnection *	mediaWikiConnection
NSURLRequest *	mediaWikiRequest
NSMutableSet *	progressListeners
id< MediaWikiQueryDelegate >	queryDelegate
NSMutableData *	receivedData
BOOL	working
Properties
NSInteger	currentBytes
	Manual accessor for currentBytes.
NSInteger	expectedSize
	Manual accessor for expectedSize.
NSString *	mediaWikiURLString
	The base URL for this MediaWiki query.

---

Detailed Description

A basic URL fetch class that reads the given URL into an NSData object and passes it on to it's delegate once the process has finished.

Created by Antti V J Niemela, tkol on 5/24/11. Copyright 2011 University of Helsinki. All rights reserved.

---

Member Function Documentation

- (void) addProgressListener:

(id <MediaWikiProgressListener>)

listener

Adds a progress listener object to this object's listeners.

Progress Listeners receive periodic updates on the progress of the data transfer taking place. Multiple listeners are supported.

Parameters:

listener

A MediaWikiProgressListener that should receive updates.

- (NSString *) buildQueryURL

Builds the query URL, intended to be easily re-implemented in sublcasses.

Builds the query URL.

The URL is based on the mediaWikiURString property. Subclasses of MediaWikiQuery will likely want to override this method.

Returns:

The URL to be used when attempting the connection

Reimplemented in MediaWikiCategoryQuery, and MediaWikiPageQuery.

Here is the caller graph for this function:

- (void) connection:		(NSURLConnection *)	connection
didFailWithError:		(NSError *)	error

NSURLConnection delegate method.

NSURLConnectionDelegate implementation, reports the error with NSLog.

Here is the call graph for this function:

- (void) connection:		(NSURLConnection *)	connection
didReceiveData:		(NSData *)	data

NSURLConnection delegate method.

NSURLConnectionDelegate implementation, reads the data into an internal variable.

- (void) connection:		(NSURLConnection *)	connection
didReceiveResponse:		(NSURLResponse *)	response

NSURLConnection delegate method.

NSURLConnectionDelegate implementation, resets the internal data buffer (only the data from the last response is stuff we're interested in).

- (void) connectionDidFinishLoading:

(NSURLConnection *)

connection

NSURLConnection delegate method.

NSURLConnectionDelegate implementation, passes the received data to the delegate.

- (void) dealloc

[implementation]

- (id) init

[implementation]

Initializes the object.

Reimplemented in MediaWikiCategoryQuery, and MediaWikiPageQuery.

Here is the caller graph for this function:

- (id) initWithDelegate:

(id <MediaWikiQueryDelegate>)

mediaWikiQueryDelegate

Initialize a new MediaWikiQuery object with the specified delegate.

Initializes the object with the specified delegate.

Parameters:

mediaWikiQueryDelegate

The delegate object that will receive the data read from the URL

Returns:

id pointer to the initialized object.

Here is the call graph for this function:

Here is the caller graph for this function:

- (id) initWithDelegate:		(id <MediaWikiQueryDelegate>)	mediaWikiQueryDelegate
mediaWikiURL:		(NSString*)	mwURLString

Initialize a new MediaWikiQuery object with the specified delegate and MediaWiki URL (as a string)

Initializes the object with the specified delegate and MediaWiki URL.

Parameters:

mediaWikiQueryDelegate	The delegate object that will receive the data read from the URL
mwURLString	The URL to read from.

Returns:

id pointer to the initialized object.

Here is the call graph for this function:

Here is the caller graph for this function:

- (void) removeProgressListener:

(id <MediaWikiProgressListener>)

listener

Removes a progress listener object from this object's listeners.

Parameters:

listener

The listener to remove from this object's listener set.

- (BOOL) startQuery

Launches the query process.

Starts the MediaWiki query.

Starts the HTTP query represented by the URL received using [self buildQueryURL] using an internal NSURLConnection object. This object functions as the delegate for the NSURLConnection, and passes the read data to it's delegate once the connection finishes loading.

Returns:

YES if the connection started succesfully, NO if the URL was malformed or this object was already in the middle of reading data

Here is the call graph for this function:

---

Member Data Documentation

- (NSURLConnection*) mediaWikiConnection [protected]

- (NSURLRequest*) mediaWikiRequest [protected]

- (NSMutableSet*) progressListeners [protected]

- (id<MediaWikiQueryDelegate>) queryDelegate [protected]

- (NSMutableData*) receivedData [protected]

- (BOOL) working [protected]

---

Property Documentation

- (NSInteger) currentBytes [read, assign]

Manual accessor for currentBytes.

Returns:

The number of bytes of data received from the target host.

- (NSInteger) expectedSize [read, assign]

Manual accessor for expectedSize.

Only available once a NSURLResponse has been received from the target host. Returns NSIntegerMin if a response has not yet been received, and -1 when a response has been received but it did not contain information on the size of the response.

Returns:

The expected size (in 8-bit bytes) of the file, NSIntegerMin or -1.

- (NSString *) mediaWikiURLString [read, write, copy]

The base URL for this MediaWiki query.

---

The documentation for this class was generated from the following files:

• /Users/awniemel/Notepad-SVN/svn/trunk/CatNiP/CatNiP/MediaWikiQuery.h
• /Users/awniemel/Notepad-SVN/svn/trunk/CatNiP/CatNiP/MediaWikiQuery.m