C# Class Smrf.NodeXL.GraphDataProviders.Flickr.FlickrUserNetworkAnalyzer

Gets a network of Flickr users.
Use GetNetworkAsync to asynchronously get a directed network of Flickr users.
Inheritance: FlickrNetworkAnalyzerBase
Show file Open project: 2014-sed-team3/term-project

Public Methods

Method Description
AssertValid ( ) : void
FlickrUserNetworkAnalyzer ( ) : System

Initializes a new instance of the class.
GetNetworkAsync ( String screenName, WhatToInclude whatToInclude, NetworkLevel networkLevel, Int32 maximumPerRequest, String apiKey ) : void

Protected Methods

Method Description
AppendUserInformationGraphMLAttributeValues ( GraphMLXmlDocument oGraphMLXmlDocument, XmlNode>.Dictionary oUserIDDictionary, String sApiKey, RequestStatistics oRequestStatistics ) : void
AppendUserInformationGraphMLAttributeValues ( String sUserID, XmlNode oVertexXmlNode, GraphMLXmlDocument oGraphMLXmlDocument, String sApiKey, RequestStatistics oRequestStatistics ) : void
BackgroundWorker_DoWork ( object sender, DoWorkEventArgs e ) : void
CreateGraphMLXmlDocument ( System.Boolean bIncludeCommenterVertices, System.Boolean bIncludeUserInformation ) : GraphMLXmlDocument
GetCommentersEnumerator ( String sUserID, Int32 iMaximumPerRequest, System.Boolean bSkipMostPage1Errors, String sApiKey, RequestStatistics oRequestStatistics ) : IEnumerable
GetContactsOrCommentersEnumerator ( String sUserID, System.Boolean bForContacts, Int32 iMaximumPerRequest, GraphMLXmlDocument oGraphMLXmlDocument, String sApiKey, RequestStatistics oRequestStatistics ) : IEnumerable
GetNetworkDescription ( String sScreenName, WhatToInclude eWhatToInclude, NetworkLevel eNetworkLevel, Int32 iMaximumPerRequest ) : String
GetScreenNameFromVertexXmlNode ( XmlNode oVertexXmlNode ) : String
GetUserNetworkInternal ( String sScreenName, WhatToInclude eWhatToInclude, NetworkLevel eNetworkLevel, Int32 iMaximumPerRequest, String sApiKey ) : XmlDocument
GetUserNetworkInternal ( String sScreenName, WhatToInclude eWhatToInclude, NetworkLevel eNetworkLevel, Int32 iMaximumPerRequest, String sApiKey, RequestStatistics oRequestStatistics, GraphMLXmlDocument oGraphMLXmlDocument ) : void
GetUserNetworkRecursive ( String sUserID, String sScreenName, WhatToInclude eWhatToInclude, System.Boolean bIncludeContactsThisCall, NetworkLevel eNetworkLevel, Int32 iMaximumPerRequest, String sApiKey, Int32 iRecursionLevel, GraphMLXmlDocument oGraphMLXmlDocument, XmlNode>.Dictionary oUserIDDictionary, RequestStatistics oRequestStatistics ) : void
ReportProgressForContactsOrCommenters ( String sScreenName, System.Boolean bForContacts ) : void
TryAppendVertexXmlNode ( String sUserID, String sScreenName, GraphMLXmlDocument oGraphMLXmlDocument, XmlNode>.Dictionary oUserIDDictionary ) : System.Boolean
WhatToIncludeFlagIsSet ( WhatToInclude eORedEnumFlags, WhatToInclude eORedEnumFlagsToCheck ) : System.Boolean

Method Details

AppendUserInformationGraphMLAttributeValues() protected method

protected AppendUserInformationGraphMLAttributeValues ( GraphMLXmlDocument oGraphMLXmlDocument, XmlNode>.Dictionary oUserIDDictionary, String sApiKey, RequestStatistics oRequestStatistics ) : void
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
oUserIDDictionary XmlNode>.Dictionary
sApiKey String
oRequestStatistics Smrf.SocialNetworkLib.RequestStatistics
return void

AppendUserInformationGraphMLAttributeValues() protected method

protected AppendUserInformationGraphMLAttributeValues ( String sUserID, XmlNode oVertexXmlNode, GraphMLXmlDocument oGraphMLXmlDocument, String sApiKey, RequestStatistics oRequestStatistics ) : void
sUserID String
oVertexXmlNode System.Xml.XmlNode
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
sApiKey String
oRequestStatistics Smrf.SocialNetworkLib.RequestStatistics
return void

AssertValid() public method

public AssertValid ( ) : void
return void

BackgroundWorker_DoWork() protected method

protected BackgroundWorker_DoWork ( object sender, DoWorkEventArgs e ) : void
sender object
e System.ComponentModel.DoWorkEventArgs
return void

CreateGraphMLXmlDocument() protected method

protected CreateGraphMLXmlDocument ( System.Boolean bIncludeCommenterVertices, System.Boolean bIncludeUserInformation ) : GraphMLXmlDocument
bIncludeCommenterVertices System.Boolean
bIncludeUserInformation System.Boolean
return Smrf.XmlLib.GraphMLXmlDocument

FlickrUserNetworkAnalyzer() public method

Initializes a new instance of the class.
public FlickrUserNetworkAnalyzer ( ) : System
return System

GetCommentersEnumerator() protected method

protected GetCommentersEnumerator ( String sUserID, Int32 iMaximumPerRequest, System.Boolean bSkipMostPage1Errors, String sApiKey, RequestStatistics oRequestStatistics ) : IEnumerable
sUserID String
iMaximumPerRequest System.Int32
bSkipMostPage1Errors System.Boolean
sApiKey String
oRequestStatistics Smrf.SocialNetworkLib.RequestStatistics
return IEnumerable

GetContactsOrCommentersEnumerator() protected method

protected GetContactsOrCommentersEnumerator ( String sUserID, System.Boolean bForContacts, Int32 iMaximumPerRequest, GraphMLXmlDocument oGraphMLXmlDocument, String sApiKey, RequestStatistics oRequestStatistics ) : IEnumerable
sUserID String
bForContacts System.Boolean
iMaximumPerRequest System.Int32
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
sApiKey String
oRequestStatistics Smrf.SocialNetworkLib.RequestStatistics
return IEnumerable

GetNetworkAsync() public method

public GetNetworkAsync ( String screenName, WhatToInclude whatToInclude, NetworkLevel networkLevel, Int32 maximumPerRequest, String apiKey ) : void
screenName String
whatToInclude WhatToInclude
networkLevel NetworkLevel
maximumPerRequest System.Int32
apiKey String
return void

GetNetworkDescription() protected method

protected GetNetworkDescription ( String sScreenName, WhatToInclude eWhatToInclude, NetworkLevel eNetworkLevel, Int32 iMaximumPerRequest ) : String
sScreenName String
eWhatToInclude WhatToInclude
eNetworkLevel NetworkLevel
iMaximumPerRequest System.Int32
return String

GetScreenNameFromVertexXmlNode() protected method

protected GetScreenNameFromVertexXmlNode ( XmlNode oVertexXmlNode ) : String
oVertexXmlNode System.Xml.XmlNode
return String

GetUserNetworkInternal() protected method

protected GetUserNetworkInternal ( String sScreenName, WhatToInclude eWhatToInclude, NetworkLevel eNetworkLevel, Int32 iMaximumPerRequest, String sApiKey ) : XmlDocument
sScreenName String
eWhatToInclude WhatToInclude
eNetworkLevel NetworkLevel
iMaximumPerRequest System.Int32
sApiKey String
return System.Xml.XmlDocument

GetUserNetworkInternal() protected method

protected GetUserNetworkInternal ( String sScreenName, WhatToInclude eWhatToInclude, NetworkLevel eNetworkLevel, Int32 iMaximumPerRequest, String sApiKey, RequestStatistics oRequestStatistics, GraphMLXmlDocument oGraphMLXmlDocument ) : void
sScreenName String
eWhatToInclude WhatToInclude
eNetworkLevel NetworkLevel
iMaximumPerRequest System.Int32
sApiKey String
oRequestStatistics Smrf.SocialNetworkLib.RequestStatistics
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
return void

GetUserNetworkRecursive() protected method

protected GetUserNetworkRecursive ( String sUserID, String sScreenName, WhatToInclude eWhatToInclude, System.Boolean bIncludeContactsThisCall, NetworkLevel eNetworkLevel, Int32 iMaximumPerRequest, String sApiKey, Int32 iRecursionLevel, GraphMLXmlDocument oGraphMLXmlDocument, XmlNode>.Dictionary oUserIDDictionary, RequestStatistics oRequestStatistics ) : void
sUserID String
sScreenName String
eWhatToInclude WhatToInclude
bIncludeContactsThisCall System.Boolean
eNetworkLevel NetworkLevel
iMaximumPerRequest System.Int32
sApiKey String
iRecursionLevel System.Int32
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
oUserIDDictionary XmlNode>.Dictionary
oRequestStatistics Smrf.SocialNetworkLib.RequestStatistics
return void

ReportProgressForContactsOrCommenters() protected method

protected ReportProgressForContactsOrCommenters ( String sScreenName, System.Boolean bForContacts ) : void
sScreenName String
bForContacts System.Boolean
return void

TryAppendVertexXmlNode() protected method

protected TryAppendVertexXmlNode ( String sUserID, String sScreenName, GraphMLXmlDocument oGraphMLXmlDocument, XmlNode>.Dictionary oUserIDDictionary ) : System.Boolean
sUserID String
sScreenName String
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
oUserIDDictionary XmlNode>.Dictionary
return System.Boolean

WhatToIncludeFlagIsSet() protected method

protected WhatToIncludeFlagIsSet ( WhatToInclude eORedEnumFlags, WhatToInclude eORedEnumFlagsToCheck ) : System.Boolean
eORedEnumFlags WhatToInclude
eORedEnumFlagsToCheck WhatToInclude
return System.Boolean