C# Class Smrf.NodeXL.GraphDataProviders.Twitter.TwitterNetworkAnalyzerBase

Base class for classes that analyze a Twitter network.
The derived class must call BeforeGetNetwork() before getting each network.
Inheritance: HttpNetworkAnalyzerBase
Show file Open project: 2014-sed-team3/term-project

Protected Properties

Property Type Description
HttpStatusCodesToFailImmediately HttpStatusCode[]
m_oTwitterStatusTextParser Smrf.SocialNetworkLib.Twitter.TwitterStatusTextParser
m_oTwitterUtil Smrf.SocialNetworkLib.Twitter.TwitterUtil

Public Methods

Method Description
AssertValid ( ) : void
ExceptionToMessage ( Exception oException ) : String
TwitterNetworkAnalyzerBase ( ) : System

Initializes a new instance of the class.

Protected Methods

Method Description
AppendFollowedOrFollowingEdgeXmlNode ( String sScreenName, String sOtherScreenName, System.Boolean bFollowed, GraphMLXmlDocument oGraphMLXmlDocument, RequestStatistics oRequestStatistics ) : void
AppendFollowedOrFollowingEdgeXmlNodes ( TwitterUser>.Dictionary oUserIDDictionary, System.Boolean bFollowed, Int32 iMaximumPeoplePerRequest, GraphMLXmlDocument oGraphMLXmlDocument, RequestStatistics oRequestStatistics ) : void
AppendFollowedOrFollowingEdgeXmlNodes ( ICollection oScreenNames, TwitterUser>.Dictionary oUserIDDictionary, System.Boolean bFollowed, Int32 iMaximumPeoplePerRequest, GraphMLXmlDocument oGraphMLXmlDocument, RequestStatistics oRequestStatistics ) : void
AppendLatestStatusInformationFromValueDictionary ( Object>.Dictionary oStatusValueDictionary, GraphMLXmlDocument oGraphMLXmlDocument, TwitterUser oTwitterUser, System.Boolean bIncludeLatestStatus, System.Boolean bExpandLatestStatusUrls ) : void
AppendRepliesToAndMentionsEdgeXmlNodes ( GraphMLXmlDocument oGraphMLXmlDocument, IEnumerable oTwitterUsers, HashSet oUniqueScreenNames, System.Boolean bIncludeRepliesToEdges, System.Boolean bIncludeMentionsEdges, System.Boolean bIncludeNonRepliesToNonMentionsEdges, System.Boolean bIncludeStatuses ) : void
AppendStartTimeRelationshipDateUtcGraphMLAttributeValue ( GraphMLXmlDocument oGraphMLXmlDocument, XmlNode oEdgeXmlNode, RequestStatistics oRequestStatistics ) : void
AppendUserInformationFromValueDictionary ( Object>.Dictionary oUserValueDictionary, GraphMLXmlDocument oGraphMLXmlDocument, TwitterUser oTwitterUser, System.Boolean bIncludeStatistics, System.Boolean bIncludeLatestStatus, System.Boolean bExpandLatestStatusUrls ) : void
BeforeGetNetwork ( ) : void
EnumerateFriendOrFollowerIDs ( String sScreenName, System.Boolean bFollowed, Int32 iMaximumPeoplePerRequest, RequestStatistics oRequestStatistics ) : IEnumerable
EnumerateJsonValues ( String sUrl, String sJsonName, Int32 iMaximumValues, System.Boolean bSkipMostPage1Errors, RequestStatistics oRequestStatistics ) : IEnumerable
EnumerateUserValueDictionaries ( String asUserIDsOrScreenNames, System.Boolean bUserIDsSpecified, RequestStatistics oRequestStatistics ) : Object>>.IEnumerable
GetTwitterResponseAsString ( String sUrl, RequestStatistics oRequestStatistics ) : String
ReportProgressForFollowedOrFollowing ( String sScreenName, System.Boolean bFollowed ) : void
TryGetScreenNameFromDictionary ( Object>.Dictionary oUserValueDictionary, String &sScreenName ) : System.Boolean
TryGetUserIDFromDictionary ( Object>.Dictionary oUserValueDictionary, String &sUserID ) : System.Boolean
TryGetUserValueDictionary ( String sScreenName, RequestStatistics oRequestStatistics, System.Boolean bIgnoreWebAndJsonExceptions, Object>.Dictionary &oUserValueDictionary ) : System.Boolean

Method Details

AppendFollowedOrFollowingEdgeXmlNode() protected method

protected AppendFollowedOrFollowingEdgeXmlNode ( String sScreenName, String sOtherScreenName, System.Boolean bFollowed, GraphMLXmlDocument oGraphMLXmlDocument, RequestStatistics oRequestStatistics ) : void
sScreenName String
sOtherScreenName String
bFollowed System.Boolean
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
oRequestStatistics Smrf.SocialNetworkLib.RequestStatistics
return void

AppendFollowedOrFollowingEdgeXmlNodes() protected method

protected AppendFollowedOrFollowingEdgeXmlNodes ( TwitterUser>.Dictionary oUserIDDictionary, System.Boolean bFollowed, Int32 iMaximumPeoplePerRequest, GraphMLXmlDocument oGraphMLXmlDocument, RequestStatistics oRequestStatistics ) : void
oUserIDDictionary TwitterUser>.Dictionary
bFollowed System.Boolean
iMaximumPeoplePerRequest System.Int32
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
oRequestStatistics Smrf.SocialNetworkLib.RequestStatistics
return void

AppendFollowedOrFollowingEdgeXmlNodes() protected method

protected AppendFollowedOrFollowingEdgeXmlNodes ( ICollection oScreenNames, TwitterUser>.Dictionary oUserIDDictionary, System.Boolean bFollowed, Int32 iMaximumPeoplePerRequest, GraphMLXmlDocument oGraphMLXmlDocument, RequestStatistics oRequestStatistics ) : void
oScreenNames ICollection
oUserIDDictionary TwitterUser>.Dictionary
bFollowed System.Boolean
iMaximumPeoplePerRequest System.Int32
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
oRequestStatistics Smrf.SocialNetworkLib.RequestStatistics
return void

AppendLatestStatusInformationFromValueDictionary() protected method

protected AppendLatestStatusInformationFromValueDictionary ( Object>.Dictionary oStatusValueDictionary, GraphMLXmlDocument oGraphMLXmlDocument, TwitterUser oTwitterUser, System.Boolean bIncludeLatestStatus, System.Boolean bExpandLatestStatusUrls ) : void
oStatusValueDictionary Object>.Dictionary
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
oTwitterUser Smrf.NodeXL.GraphMLLib.TwitterUser
bIncludeLatestStatus System.Boolean
bExpandLatestStatusUrls System.Boolean
return void

AppendRepliesToAndMentionsEdgeXmlNodes() protected method

protected AppendRepliesToAndMentionsEdgeXmlNodes ( GraphMLXmlDocument oGraphMLXmlDocument, IEnumerable oTwitterUsers, HashSet oUniqueScreenNames, System.Boolean bIncludeRepliesToEdges, System.Boolean bIncludeMentionsEdges, System.Boolean bIncludeNonRepliesToNonMentionsEdges, System.Boolean bIncludeStatuses ) : void
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
oTwitterUsers IEnumerable
oUniqueScreenNames HashSet
bIncludeRepliesToEdges System.Boolean
bIncludeMentionsEdges System.Boolean
bIncludeNonRepliesToNonMentionsEdges System.Boolean
bIncludeStatuses System.Boolean
return void

AppendStartTimeRelationshipDateUtcGraphMLAttributeValue() protected method

protected AppendStartTimeRelationshipDateUtcGraphMLAttributeValue ( GraphMLXmlDocument oGraphMLXmlDocument, XmlNode oEdgeXmlNode, RequestStatistics oRequestStatistics ) : void
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
oEdgeXmlNode System.Xml.XmlNode
oRequestStatistics Smrf.SocialNetworkLib.RequestStatistics
return void

AppendUserInformationFromValueDictionary() protected method

protected AppendUserInformationFromValueDictionary ( Object>.Dictionary oUserValueDictionary, GraphMLXmlDocument oGraphMLXmlDocument, TwitterUser oTwitterUser, System.Boolean bIncludeStatistics, System.Boolean bIncludeLatestStatus, System.Boolean bExpandLatestStatusUrls ) : void
oUserValueDictionary Object>.Dictionary
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
oTwitterUser Smrf.NodeXL.GraphMLLib.TwitterUser
bIncludeStatistics System.Boolean
bIncludeLatestStatus System.Boolean
bExpandLatestStatusUrls System.Boolean
return void

AssertValid() public method

public AssertValid ( ) : void
return void

BeforeGetNetwork() protected method

protected BeforeGetNetwork ( ) : void
return void

EnumerateFriendOrFollowerIDs() protected method

protected EnumerateFriendOrFollowerIDs ( String sScreenName, System.Boolean bFollowed, Int32 iMaximumPeoplePerRequest, RequestStatistics oRequestStatistics ) : IEnumerable
sScreenName String
bFollowed System.Boolean
iMaximumPeoplePerRequest System.Int32
oRequestStatistics Smrf.SocialNetworkLib.RequestStatistics
return IEnumerable

EnumerateJsonValues() protected method

protected EnumerateJsonValues ( String sUrl, String sJsonName, Int32 iMaximumValues, System.Boolean bSkipMostPage1Errors, RequestStatistics oRequestStatistics ) : IEnumerable
sUrl String
sJsonName String
iMaximumValues System.Int32
bSkipMostPage1Errors System.Boolean
oRequestStatistics Smrf.SocialNetworkLib.RequestStatistics
return IEnumerable

EnumerateUserValueDictionaries() protected method

protected EnumerateUserValueDictionaries ( String asUserIDsOrScreenNames, System.Boolean bUserIDsSpecified, RequestStatistics oRequestStatistics ) : Object>>.IEnumerable
asUserIDsOrScreenNames String
bUserIDsSpecified System.Boolean
oRequestStatistics Smrf.SocialNetworkLib.RequestStatistics
return Object>>.IEnumerable

ExceptionToMessage() public method

public ExceptionToMessage ( Exception oException ) : String
oException System.Exception
return String

GetTwitterResponseAsString() protected method

protected GetTwitterResponseAsString ( String sUrl, RequestStatistics oRequestStatistics ) : String
sUrl String
oRequestStatistics Smrf.SocialNetworkLib.RequestStatistics
return String

ReportProgressForFollowedOrFollowing() protected method

protected ReportProgressForFollowedOrFollowing ( String sScreenName, System.Boolean bFollowed ) : void
sScreenName String
bFollowed System.Boolean
return void

TryGetScreenNameFromDictionary() protected method

protected TryGetScreenNameFromDictionary ( Object>.Dictionary oUserValueDictionary, String &sScreenName ) : System.Boolean
oUserValueDictionary Object>.Dictionary
sScreenName String
return System.Boolean

TryGetUserIDFromDictionary() protected method

protected TryGetUserIDFromDictionary ( Object>.Dictionary oUserValueDictionary, String &sUserID ) : System.Boolean
oUserValueDictionary Object>.Dictionary
sUserID String
return System.Boolean

TryGetUserValueDictionary() protected method

protected TryGetUserValueDictionary ( String sScreenName, RequestStatistics oRequestStatistics, System.Boolean bIgnoreWebAndJsonExceptions, Object>.Dictionary &oUserValueDictionary ) : System.Boolean
sScreenName String
oRequestStatistics Smrf.SocialNetworkLib.RequestStatistics
bIgnoreWebAndJsonExceptions System.Boolean
oUserValueDictionary Object>.Dictionary
return System.Boolean

TwitterNetworkAnalyzerBase() public method

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

Property Details

HttpStatusCodesToFailImmediately protected static property

protected static HttpStatusCode[] HttpStatusCodesToFailImmediately
return HttpStatusCode[]

m_oTwitterStatusTextParser protected property

protected TwitterStatusTextParser,Smrf.SocialNetworkLib.Twitter m_oTwitterStatusTextParser
return Smrf.SocialNetworkLib.Twitter.TwitterStatusTextParser

m_oTwitterUtil protected property

protected TwitterUtil,Smrf.SocialNetworkLib.Twitter m_oTwitterUtil
return Smrf.SocialNetworkLib.Twitter.TwitterUtil