Encapsulates a MediaWiki API category query. More...

#import <MediaWikiCategoryQuery.h>

Inheritance diagram for MediaWikiCategoryQuery:

Collaboration diagram for MediaWikiCategoryQuery:

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.
(id)	- init `[implementation]`
	Base init method for MediaWikiCategoryQuery objects.
(void)	- parseCategoryXML:
	Launch method for parsing the XML data from a NSData object.
(void)	- parser:didStartElement:namespaceURI:qualifiedName:attributes:
	NSXMLParserDelegate method implementation.
(void)	- parser:parseErrorOccurred:
	NSXMLParserDelegate method implementation.
(void)	- parser:validationErrorOccurred:
	NSXMLParserDelegate method implementation.
(void)	- parserDidEndDocument:
	NSXMLParserDelegate method implementation.
(void)	- parserDidStartDocument:
	NSXMLParserDelegate method implementation.
(void)	- setCategoryName: `[implementation]`
(void)	- setChunkSize: `[implementation]`
(void)	- setReturnFormat: `[implementation]`
(void)	- setWikiAction: `[implementation]`
Static Public Member Functions
(MediaWikiCategoryQuery *)	+ newCategoryQuery:delegate:
	Builds a MediaWikiCategoryQuery and returns it.
Properties
id < MediaWikiCategoryQueryDelegate >	categoryDelegate
	The delegate to pass read categories and any error messages to.
NSString *	categoryName
	Defines the category name for a category contents query.
NSString *	chunkSize
	Defines the chunk size to be read from the MediaWiki when doing a category contents query, ie.
NSString *	continueFrom
	A property specifying the beginning point for the next category contents query.
NSMutableDictionary *	parameters
	A dictionary object that holds the parameter data.
NSString *	returnFormat
	Defines the return format for this MediaWiki API query.
NSString *	wikiAction
	Defines the action parameter for this MediaWiki API query.
NSString *	wikiQuery
	Defines the query subtype.
NSArray *	wikiQueryPageIds
	MediaWiki API parameter that accepts a comma-delimeted list of wiki page ids as the set to query for eg.
NSArray *	wikiQueryTitles
	MediaWiki API parameter that accepts a comma-delimeted list of wiki page titles as the set to query for eg.
NSString *	wikiQueryType
	Defines the wiki query type.

Detailed Description

Encapsulates a MediaWiki API category query.

Currently only supports the xml format, and will try to parse the received data even if you manually set the format property to whatever.

Used by the IMSLPQueryHelper to handle category queries to the IMSLP site.

Definition at line 15 of file MediaWikiCategoryQuery.h.

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.

Definition at line 154 of file MediaWikiCategoryQuery.m.

References continueFrom.

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.

Definition at line 87 of file MediaWikiCategoryQuery.m.

References _buildGetParams.

Here is the call graph for this function:

- (void) didReceiveMediaWikiData: (NSData *) data [implementation]

MediaWikiQueryDelegate method implementation.

Launches the XML parse process.

Reimplemented from <MediaWikiQueryDelegate>.

Definition at line 93 of file MediaWikiCategoryQuery.m.

References parseCategoryXML:.

Here is the call graph for this function:

- (id) init [implementation]

Base init method for MediaWikiCategoryQuery objects.

Reimplemented from MediaWikiQuery.

Definition at line 78 of file MediaWikiCategoryQuery.m.

+ (MediaWikiCategoryQuery *) newCategoryQuery:	(NSString*)	URL
delegate:	(id <MediaWikiCategoryQueryDelegate>)	qDelegate

Builds a MediaWikiCategoryQuery and returns it.

This static "factory" method builds a MediaWikiCategoryQuery object that will access the given URL and report the category data read to the delegate passed. You will need to set the actual category manually by using the MediaWikiQuery* categoryName property before starting the actual query process.

Definition at line 63 of file MediaWikiCategoryQuery.m.

References categoryDelegate, MediaWikiQuery::initWithDelegate:mediaWikiURL:, returnFormat, wikiAction, wikiQuery, and wikiQueryType.

Here is the call graph for this function:

Here is the caller graph for this function:

- (void) parseCategoryXML: (NSData*) XMLData

Launch method for parsing the XML data from a NSData object.

Instantiates a NSXMLParser object and sets it to work, using self as a delegate.

Definition at line 97 of file MediaWikiCategoryQuery.m.

References categoryParser.

Here is the caller graph for this function: