C# Class Smrf.NodeXL.GraphDataProviders.HttpNetworkAnalyzerBase

Abstract base class for classes that analyze network information obtained via HTTP Web requests.
This base class implements properties related to HTTP Web requests, a BackgroundWorker instance, and properties, methods, and events related to the BackgroundWorker. The derived class must implement a method to start an analysis and implement the BackgroundWorker_DoWork method.
Inheritance: Object
Afficher le fichier Open project: 2014-sed-team3/term-project Class Usage Examples

Protected Properties

Свойство Type Description
HttpRetryDelaysSec System.Int32[]
m_oBackgroundWorker System.ComponentModel.BackgroundWorker

Méthodes publiques

Méthode Description
CancelAsync ( ) : void
CreateHttpWebRequest ( String url ) : HttpWebRequest
ExceptionToMessage ( Exception oException ) : String
HttpNetworkAnalyzerBase ( ) : System

Initializes a new instance of the class.

Méthodes protégées

Méthode Description
AppendDoubleGraphMLAttributeValue ( XmlNode oXmlNodeToSelectFrom, String sXPath, XmlNamespaceManager oXmlNamespaceManager, GraphMLXmlDocument oGraphMLXmlDocument, XmlNode oEdgeOrVertexXmlNode, String sGraphMLAttributeID ) : System.Boolean
AppendEdgeXmlNode ( GraphMLXmlDocument oGraphMLXmlDocument, String sVertex1ID, String sVertex2ID, String sRelationship ) : XmlNode
AppendInt32GraphMLAttributeValue ( XmlNode oXmlNodeToSelectFrom, String sXPath, XmlNamespaceManager oXmlNamespaceManager, GraphMLXmlDocument oGraphMLXmlDocument, XmlNode oEdgeOrVertexXmlNode, String sGraphMLAttributeID ) : System.Boolean
AppendStringGraphMLAttributeValue ( XmlNode oXmlNodeToSelectFrom, String sXPath, XmlNamespaceManager oXmlNamespaceManager, GraphMLXmlDocument oGraphMLXmlDocument, XmlNode oEdgeOrVertexXmlNode, String sGraphMLAttributeID ) : System.Boolean
BackgroundWorker_DoWork ( object sender, DoWorkEventArgs e ) : void
BackgroundWorker_ProgressChanged ( object sender, ProgressChangedEventArgs e ) : void
BackgroundWorker_RunWorkerCompleted ( object sender, RunWorkerCompletedEventArgs e ) : void
CheckCancellationPending ( ) : void
CheckIsBusy ( String sMethodName ) : void
DefineCustomMenuGraphMLAttributes ( GraphMLXmlDocument oGraphMLXmlDocument ) : void
DefineImageFileGraphMLAttribute ( GraphMLXmlDocument oGraphMLXmlDocument ) : void
DefineLabelGraphMLAttribute ( GraphMLXmlDocument oGraphMLXmlDocument ) : void
DefineRelationshipGraphMLAttribute ( GraphMLXmlDocument oGraphMLXmlDocument ) : void
ExceptionIsWebOrXml ( Exception oException ) : System.Boolean
FireProgressChanged ( ProgressChangedEventArgs e ) : void
GetNeedToAppendVertices ( NetworkLevel eNetworkLevel, Int32 iRecursionLevel ) : System.Boolean
GetNeedToRecurse ( NetworkLevel eNetworkLevel, Int32 iRecursionLevel ) : System.Boolean
GetXmlDocumentNoRetries ( HttpWebRequest oHttpWebRequest ) : XmlDocument
GetXmlDocumentWithRetries ( String sUrl, HttpStatusCode aeHttpStatusCodesToFailImmediately, RequestStatistics oRequestStatistics ) : XmlDocument
NetworkLevelToString ( NetworkLevel eNetworkLevel ) : String
OnNetworkObtained ( XmlDocument oGraphMLXmlDocument, RequestStatistics oRequestStatistics, String sNetworkDescription, String sNetworkTitle ) : void
OnNetworkObtainedWithoutTerminatingException ( GraphMLXmlDocument oGraphMLXmlDocument, RequestStatistics oRequestStatistics, String sNetworkDescription ) : void
OnTerminatingException ( Exception oException ) : void
OnUnexpectedException ( Exception oException, XmlDocument oGraphMLXmlDocument, RequestStatistics oRequestStatistics ) : void
ReportProgress ( String sProgressMessage ) : void
WebExceptionHasHttpStatusCode ( WebException oWebException ) : System.Boolean

Private Methods

Méthode Description
AssertValid ( ) : void

Method Details

AppendDoubleGraphMLAttributeValue() protected méthode

protected AppendDoubleGraphMLAttributeValue ( XmlNode oXmlNodeToSelectFrom, String sXPath, XmlNamespaceManager oXmlNamespaceManager, GraphMLXmlDocument oGraphMLXmlDocument, XmlNode oEdgeOrVertexXmlNode, String sGraphMLAttributeID ) : System.Boolean
oXmlNodeToSelectFrom System.Xml.XmlNode
sXPath String
oXmlNamespaceManager System.Xml.XmlNamespaceManager
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
oEdgeOrVertexXmlNode System.Xml.XmlNode
sGraphMLAttributeID String
Résultat System.Boolean

AppendEdgeXmlNode() protected méthode

protected AppendEdgeXmlNode ( GraphMLXmlDocument oGraphMLXmlDocument, String sVertex1ID, String sVertex2ID, String sRelationship ) : XmlNode
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
sVertex1ID String
sVertex2ID String
sRelationship String
Résultat System.Xml.XmlNode

AppendInt32GraphMLAttributeValue() protected méthode

protected AppendInt32GraphMLAttributeValue ( XmlNode oXmlNodeToSelectFrom, String sXPath, XmlNamespaceManager oXmlNamespaceManager, GraphMLXmlDocument oGraphMLXmlDocument, XmlNode oEdgeOrVertexXmlNode, String sGraphMLAttributeID ) : System.Boolean
oXmlNodeToSelectFrom System.Xml.XmlNode
sXPath String
oXmlNamespaceManager System.Xml.XmlNamespaceManager
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
oEdgeOrVertexXmlNode System.Xml.XmlNode
sGraphMLAttributeID String
Résultat System.Boolean

AppendStringGraphMLAttributeValue() protected méthode

protected AppendStringGraphMLAttributeValue ( XmlNode oXmlNodeToSelectFrom, String sXPath, XmlNamespaceManager oXmlNamespaceManager, GraphMLXmlDocument oGraphMLXmlDocument, XmlNode oEdgeOrVertexXmlNode, String sGraphMLAttributeID ) : System.Boolean
oXmlNodeToSelectFrom System.Xml.XmlNode
sXPath String
oXmlNamespaceManager System.Xml.XmlNamespaceManager
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
oEdgeOrVertexXmlNode System.Xml.XmlNode
sGraphMLAttributeID String
Résultat System.Boolean

BackgroundWorker_DoWork() protected abstract méthode

protected abstract BackgroundWorker_DoWork ( object sender, DoWorkEventArgs e ) : void
sender object
e System.ComponentModel.DoWorkEventArgs
Résultat void

BackgroundWorker_ProgressChanged() protected méthode

protected BackgroundWorker_ProgressChanged ( object sender, ProgressChangedEventArgs e ) : void
sender object
e System.ComponentModel.ProgressChangedEventArgs
Résultat void

BackgroundWorker_RunWorkerCompleted() protected méthode

protected BackgroundWorker_RunWorkerCompleted ( object sender, RunWorkerCompletedEventArgs e ) : void
sender object
e System.ComponentModel.RunWorkerCompletedEventArgs
Résultat void

CancelAsync() public méthode

public CancelAsync ( ) : void
Résultat void

CheckCancellationPending() protected méthode

protected CheckCancellationPending ( ) : void
Résultat void

CheckIsBusy() protected méthode

protected CheckIsBusy ( String sMethodName ) : void
sMethodName String
Résultat void

CreateHttpWebRequest() public static méthode

public static CreateHttpWebRequest ( String url ) : HttpWebRequest
url String
Résultat System.Net.HttpWebRequest

DefineCustomMenuGraphMLAttributes() protected méthode

protected DefineCustomMenuGraphMLAttributes ( GraphMLXmlDocument oGraphMLXmlDocument ) : void
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
Résultat void

DefineImageFileGraphMLAttribute() protected méthode

protected DefineImageFileGraphMLAttribute ( GraphMLXmlDocument oGraphMLXmlDocument ) : void
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
Résultat void

DefineLabelGraphMLAttribute() protected méthode

protected DefineLabelGraphMLAttribute ( GraphMLXmlDocument oGraphMLXmlDocument ) : void
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
Résultat void

DefineRelationshipGraphMLAttribute() protected méthode

protected DefineRelationshipGraphMLAttribute ( GraphMLXmlDocument oGraphMLXmlDocument ) : void
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
Résultat void

ExceptionIsWebOrXml() protected méthode

protected ExceptionIsWebOrXml ( Exception oException ) : System.Boolean
oException System.Exception
Résultat System.Boolean

ExceptionToMessage() public abstract méthode

public abstract ExceptionToMessage ( Exception oException ) : String
oException System.Exception
Résultat String

FireProgressChanged() protected méthode

protected FireProgressChanged ( ProgressChangedEventArgs e ) : void
e System.ComponentModel.ProgressChangedEventArgs
Résultat void

GetNeedToAppendVertices() protected méthode

protected GetNeedToAppendVertices ( NetworkLevel eNetworkLevel, Int32 iRecursionLevel ) : System.Boolean
eNetworkLevel NetworkLevel
iRecursionLevel System.Int32
Résultat System.Boolean

GetNeedToRecurse() protected méthode

protected GetNeedToRecurse ( NetworkLevel eNetworkLevel, Int32 iRecursionLevel ) : System.Boolean
eNetworkLevel NetworkLevel
iRecursionLevel System.Int32
Résultat System.Boolean

GetXmlDocumentNoRetries() protected méthode

protected GetXmlDocumentNoRetries ( HttpWebRequest oHttpWebRequest ) : XmlDocument
oHttpWebRequest System.Net.HttpWebRequest
Résultat System.Xml.XmlDocument

GetXmlDocumentWithRetries() protected méthode

protected GetXmlDocumentWithRetries ( String sUrl, HttpStatusCode aeHttpStatusCodesToFailImmediately, RequestStatistics oRequestStatistics ) : XmlDocument
sUrl String
aeHttpStatusCodesToFailImmediately HttpStatusCode
oRequestStatistics RequestStatistics
Résultat System.Xml.XmlDocument

HttpNetworkAnalyzerBase() public méthode

Initializes a new instance of the class.
public HttpNetworkAnalyzerBase ( ) : System
Résultat System

NetworkLevelToString() protected méthode

protected NetworkLevelToString ( NetworkLevel eNetworkLevel ) : String
eNetworkLevel NetworkLevel
Résultat String

OnNetworkObtained() protected méthode

protected OnNetworkObtained ( XmlDocument oGraphMLXmlDocument, RequestStatistics oRequestStatistics, String sNetworkDescription, String sNetworkTitle ) : void
oGraphMLXmlDocument System.Xml.XmlDocument
oRequestStatistics RequestStatistics
sNetworkDescription String
sNetworkTitle String
Résultat void

OnNetworkObtainedWithoutTerminatingException() protected méthode

protected OnNetworkObtainedWithoutTerminatingException ( GraphMLXmlDocument oGraphMLXmlDocument, RequestStatistics oRequestStatistics, String sNetworkDescription ) : void
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
oRequestStatistics RequestStatistics
sNetworkDescription String
Résultat void

OnTerminatingException() protected méthode

protected OnTerminatingException ( Exception oException ) : void
oException System.Exception
Résultat void

OnUnexpectedException() protected méthode

protected OnUnexpectedException ( Exception oException, XmlDocument oGraphMLXmlDocument, RequestStatistics oRequestStatistics ) : void
oException System.Exception
oGraphMLXmlDocument System.Xml.XmlDocument
oRequestStatistics RequestStatistics
Résultat void

ReportProgress() protected méthode

protected ReportProgress ( String sProgressMessage ) : void
sProgressMessage String
Résultat void

WebExceptionHasHttpStatusCode() protected méthode

protected WebExceptionHasHttpStatusCode ( WebException oWebException ) : System.Boolean
oWebException System.Net.WebException
Résultat System.Boolean

Property Details

HttpRetryDelaysSec protected_oe static_oe property

protected static Int32[],System HttpRetryDelaysSec
Résultat System.Int32[]

m_oBackgroundWorker protected_oe property

protected BackgroundWorker,System.ComponentModel m_oBackgroundWorker
Résultat System.ComponentModel.BackgroundWorker