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

Gets a network of related Flickr tags.
Use GetNetworkAsync to asynchronously get an undirected network of Flickr tags that are related to a specified tag.
Inheritance: FlickrNetworkAnalyzerBase
Show file Open project: 2014-sed-team3/term-project

Public Methods

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

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

Protected Methods

Method Description
AppendSampleThumbnails ( XmlNode>.Dictionary oTagDictionary, GraphMLXmlDocument oGraphMLXmlDocument, String sApiKey, RequestStatistics oRequestStatistics ) : void
AppendVertexXmlNode ( String sTag, GraphMLXmlDocument oGraphMLXmlDocument, XmlNode>.Dictionary oTagDictionary ) : void
BackgroundWorker_DoWork ( object sender, DoWorkEventArgs e ) : void
CreateGraphMLXmlDocument ( System.Boolean bIncludeSampleThumbnails ) : GraphMLXmlDocument
GetNetworkDescription ( String sTag, WhatToInclude eWhatToInclude, NetworkLevel eNetworkLevel ) : String
GetRelatedTagsInternal ( String sTag, WhatToInclude eWhatToInclude, NetworkLevel eNetworkLevel, String sApiKey ) : XmlDocument
GetRelatedTagsInternal ( String sTag, WhatToInclude eWhatToInclude, NetworkLevel eNetworkLevel, String sApiKey, RequestStatistics oRequestStatistics, GraphMLXmlDocument oGraphMLXmlDocument ) : void
GetRelatedTagsRecursive ( String sTag, WhatToInclude eWhatToInclude, NetworkLevel eNetworkLevel, String sApiKey, Int32 iRecursionLevel, GraphMLXmlDocument oGraphMLXmlDocument, XmlNode>.Dictionary oTagDictionary, RequestStatistics oRequestStatistics ) : void
TryGetSampleImageUrl ( String sTag, String sApiKey, RequestStatistics oRequestStatistics, String &sSampleImageUrl ) : System.Boolean
WhatToIncludeFlagIsSet ( WhatToInclude eORedEnumFlags, WhatToInclude eORedEnumFlagsToCheck ) : System.Boolean

Method Details

AppendSampleThumbnails() protected method

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

AppendVertexXmlNode() protected method

protected AppendVertexXmlNode ( String sTag, GraphMLXmlDocument oGraphMLXmlDocument, XmlNode>.Dictionary oTagDictionary ) : void
sTag String
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
oTagDictionary XmlNode>.Dictionary
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 bIncludeSampleThumbnails ) : GraphMLXmlDocument
bIncludeSampleThumbnails System.Boolean
return Smrf.XmlLib.GraphMLXmlDocument

FlickrRelatedTagNetworkAnalyzer() public method

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

GetNetworkAsync() public method

public GetNetworkAsync ( String tag, WhatToInclude whatToInclude, NetworkLevel networkLevel, String apiKey ) : void
tag String
whatToInclude WhatToInclude
networkLevel NetworkLevel
apiKey String
return void

GetNetworkDescription() protected method

protected GetNetworkDescription ( String sTag, WhatToInclude eWhatToInclude, NetworkLevel eNetworkLevel ) : String
sTag String
eWhatToInclude WhatToInclude
eNetworkLevel NetworkLevel
return String

GetRelatedTagsInternal() protected method

protected GetRelatedTagsInternal ( String sTag, WhatToInclude eWhatToInclude, NetworkLevel eNetworkLevel, String sApiKey ) : XmlDocument
sTag String
eWhatToInclude WhatToInclude
eNetworkLevel NetworkLevel
sApiKey String
return System.Xml.XmlDocument

GetRelatedTagsInternal() protected method

protected GetRelatedTagsInternal ( String sTag, WhatToInclude eWhatToInclude, NetworkLevel eNetworkLevel, String sApiKey, RequestStatistics oRequestStatistics, GraphMLXmlDocument oGraphMLXmlDocument ) : void
sTag String
eWhatToInclude WhatToInclude
eNetworkLevel NetworkLevel
sApiKey String
oRequestStatistics Smrf.SocialNetworkLib.RequestStatistics
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
return void

GetRelatedTagsRecursive() protected method

protected GetRelatedTagsRecursive ( String sTag, WhatToInclude eWhatToInclude, NetworkLevel eNetworkLevel, String sApiKey, Int32 iRecursionLevel, GraphMLXmlDocument oGraphMLXmlDocument, XmlNode>.Dictionary oTagDictionary, RequestStatistics oRequestStatistics ) : void
sTag String
eWhatToInclude WhatToInclude
eNetworkLevel NetworkLevel
sApiKey String
iRecursionLevel System.Int32
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
oTagDictionary XmlNode>.Dictionary
oRequestStatistics Smrf.SocialNetworkLib.RequestStatistics
return void

TryGetSampleImageUrl() protected method

protected TryGetSampleImageUrl ( String sTag, String sApiKey, RequestStatistics oRequestStatistics, String &sSampleImageUrl ) : System.Boolean
sTag String
sApiKey String
oRequestStatistics Smrf.SocialNetworkLib.RequestStatistics
sSampleImageUrl String
return System.Boolean

WhatToIncludeFlagIsSet() protected method

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