MediaWikiPageQuery Class Reference

MediaWikiPageQueries do regular-expression -based wikitext parsing, reading IMSLP score information. More...

#import <MediaWikiPageQuery.h>

Inheritance diagram for MediaWikiPageQuery:

Collaboration diagram for MediaWikiPageQuery:

List of all members.

Public Member Functions
(NSString *)	- _buildGetParams
	A private worker method that does the actual GET parameter building work.
(NSString *)	- buildQueryURL [implementation]
	Overrides the default MediaWikiQuery buildQueryURL method to append the GET parameters into the URL.
(void)	- didReceiveMediaWikiData: [implementation]
	MediaWikiQueryDelegate method implementation, takes the raw wikidata read and parses it to get to the sweet sweet score file metadata (and the score filenames as well).
(id)	- init [implementation]
	Basic init method for MediaWikiPageQuery objects.
(void)	- setWikiAction: [implementation]
(void)	- setWikiTitle: [implementation]
Static Public Member Functions
(MediaWikiPageQuery *)	+ newPageQuery:delegate:
	A factory method for constructing a MediaWiki wikitext/page query object.
Properties
NSString *	composerName
	The IMSLP composer name of the composition to be read.
id< MediaWikiPageQueryDelegate >	pageDelegate
	Delegate to pass page data to.
NSMutableDictionary *	parameters
	A dictionary object that holds the parameter data.
NSString *	wikiAction
	Defines the action parameter for this MediaWiki page query.
NSString *	wikiTitle
	Defines the page title parameter for this MediaWiki page query.

---

Detailed Description

MediaWikiPageQueries do regular-expression -based wikitext parsing, reading IMSLP score information.

Perhaps misleadingly named MediaWiki instead of IMSLP, instances of this class parse the wikitext describing a particular composition and search for any embedded score files. The data for the composition is then encapsulated in a CompositionData object and passed on to the delegate for further processing.

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

---

Member Function Documentation

- (NSString *) _buildGetParams

A private worker method that does the actual GET parameter building work.

Returns the GET parameters as a NSString object.

Here is the caller graph for this function:

- (NSString *) buildQueryURL

[implementation]

Overrides the default MediaWikiQuery buildQueryURL method to append the GET parameters into the URL.

Reimplemented from MediaWikiQuery.

Here is the call graph for this function:

- (void) didReceiveMediaWikiData:

(NSData *)

data

[implementation]

MediaWikiQueryDelegate method implementation, takes the raw wikidata read and parses it to get to the sweet sweet score file metadata (and the score filenames as well).

Passes the read data to it's delegate in the form of an IMSLPCompositionData object.

Reimplemented from <MediaWikiQueryDelegate>.

Here is the call graph for this function:

- (id) init

[implementation]

Basic init method for MediaWikiPageQuery objects.

Reimplemented from MediaWikiQuery.

+ (MediaWikiPageQuery *) newPageQuery:		(NSString*)	URL
delegate:		(id <MediaWikiPageQueryDelegate>)	qDelegate

A factory method for constructing a MediaWiki wikitext/page query object.

Parameters:

URL	The base MediaWiki API url
delegate	The delegate which will receive read progress reports.

Returns:

MediaWikiPageQuery object which can perform the requested query.

Here is the call graph for this function:

Here is the caller graph for this function:

- (void) setWikiAction:

(NSString *)

wikiAction

[implementation]

- (void) setWikiTitle:

(NSString *)

wikiTitle

[implementation]

---

Property Documentation

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

The IMSLP composer name of the composition to be read.

- (id<MediaWikiPageQueryDelegate>) pageDelegate [read, write, retain]

Delegate to pass page data to.

- (NSMutableDictionary*) parameters [read, write, retain]

A dictionary object that holds the parameter data.

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

Defines the action parameter for this MediaWiki page query.

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

Defines the page title parameter for this MediaWiki page query.

---

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

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