//============================================================ // CLASS SUMMARY //============================================================ /// <summary> /// Provides example code for the ApmlProfile class. /// </summary> public static void ClassExample() { #region ApmlProfile ApmlDocument document = new ApmlDocument(); document.DefaultProfileName = "Work"; document.Head.Title = "Example APML file for apml.org"; document.Head.Generator = "Written by Hand"; document.Head.EmailAddress = "*****@*****.**"; document.Head.CreatedOn = new DateTime(2007, 3, 11, 13, 55, 0); // Create home attention profile ApmlProfile homeProfile = new ApmlProfile(); homeProfile.Name = "Home"; homeProfile.ImplicitConcepts.Add(new ApmlConcept("attention", 0.99m, "GatheringTool.com", new DateTime(2007, 3, 11, 13, 55, 0))); homeProfile.ImplicitConcepts.Add(new ApmlConcept("content distribution", 0.97m, "GatheringTool.com", new DateTime(2007, 3, 11, 13, 55, 0))); homeProfile.ImplicitConcepts.Add(new ApmlConcept("information", 0.95m, "GatheringTool.com", new DateTime(2007, 3, 11, 13, 55, 0))); homeProfile.ImplicitConcepts.Add(new ApmlConcept("business", 0.93m, "GatheringTool.com", new DateTime(2007, 3, 11, 13, 55, 0))); homeProfile.ImplicitConcepts.Add(new ApmlConcept("alerting", 0.91m, "GatheringTool.com", new DateTime(2007, 3, 11, 13, 55, 0))); homeProfile.ImplicitConcepts.Add(new ApmlConcept("intelligent agents", 0.89m, "GatheringTool.com", new DateTime(2007, 3, 11, 13, 55, 0))); homeProfile.ImplicitConcepts.Add(new ApmlConcept("development", 0.87m, "GatheringTool.com", new DateTime(2007, 3, 11, 13, 55, 0))); homeProfile.ImplicitConcepts.Add(new ApmlConcept("service", 0.85m, "GatheringTool.com", new DateTime(2007, 3, 11, 13, 55, 0))); homeProfile.ImplicitConcepts.Add(new ApmlConcept("user interface", 0.83m, "GatheringTool.com", new DateTime(2007, 3, 11, 13, 55, 0))); homeProfile.ImplicitConcepts.Add(new ApmlConcept("experience design", 0.81m, "GatheringTool.com", new DateTime(2007, 3, 11, 13, 55, 0))); homeProfile.ImplicitConcepts.Add(new ApmlConcept("site design", 0.79m, "GatheringTool.com", new DateTime(2007, 3, 11, 13, 55, 0))); homeProfile.ImplicitConcepts.Add(new ApmlConcept("television", 0.77m, "GatheringTool.com", new DateTime(2007, 3, 11, 13, 55, 0))); homeProfile.ImplicitConcepts.Add(new ApmlConcept("management", 0.75m, "GatheringTool.com", new DateTime(2007, 3, 11, 13, 55, 0))); homeProfile.ImplicitConcepts.Add(new ApmlConcept("media", 0.73m, "GatheringTool.com", new DateTime(2007, 3, 11, 13, 55, 0))); ApmlSource apmlSpecSource = new ApmlSource(); apmlSpecSource.Key = "http://feeds.feedburner.com/apmlspec"; apmlSpecSource.Name = "APML.org"; apmlSpecSource.Value = 1.00m; apmlSpecSource.MimeType = "application/rss+xml"; apmlSpecSource.From = "GatheringTool.com"; apmlSpecSource.UpdatedOn = new DateTime(2007, 3, 11, 13, 55, 0); apmlSpecSource.Authors.Add(new ApmlAuthor("Sample", 0.5m, "GatheringTool.com", new DateTime(2007, 3, 11, 13, 55, 0))); homeProfile.ImplicitSources.Add(apmlSpecSource); homeProfile.ExplicitConcepts.Add(new ApmlConcept("direct attention", 0.99m)); ApmlSource techCrunchSource = new ApmlSource(); techCrunchSource.Key = "http://feeds.feedburner.com/TechCrunch"; techCrunchSource.Name = "Techcrunch"; techCrunchSource.Value = 0.4m; techCrunchSource.MimeType = "application/rss+xml"; techCrunchSource.Authors.Add(new ApmlAuthor("ExplicitSample", 0.5m)); homeProfile.ExplicitSources.Add(techCrunchSource); document.AddProfile(homeProfile); // Create work attention profile ApmlProfile workProfile = new ApmlProfile(); workProfile.Name = "Work"; homeProfile.ExplicitConcepts.Add(new ApmlConcept("Golf", 0.2m)); ApmlSource workTechCrunchSource = new ApmlSource(); workTechCrunchSource.Key = "http://feeds.feedburner.com/TechCrunch"; workTechCrunchSource.Name = "Techcrunch"; workTechCrunchSource.Value = 0.4m; workTechCrunchSource.MimeType = "application/atom+xml"; workTechCrunchSource.Authors.Add(new ApmlAuthor("ProfessionalBlogger", 0.5m)); homeProfile.ExplicitSources.Add(workTechCrunchSource); document.AddProfile(workProfile); ApmlApplication sampleApplication = new ApmlApplication("sample.com"); sampleApplication.Data = "<SampleAppEl />"; document.Applications.Add(sampleApplication); #endregion }
/// <summary> /// Modifies the <see cref="ApmlDocument"/> to match the data source. /// </summary> /// <param name="resource">The <see cref="ApmlDocument"/> to be filled.</param> /// <exception cref="ArgumentNullException">The <paramref name="resource"/> is a null reference (Nothing in Visual Basic).</exception> public void Fill(ApmlDocument resource) { //------------------------------------------------------------ // Validate parameter //------------------------------------------------------------ Guard.ArgumentNotNull(resource, "resource"); //------------------------------------------------------------ // Create namespace resolver //------------------------------------------------------------ XmlNamespaceManager manager = ApmlUtility.CreateNamespaceManager(this.Navigator.NameTable); //------------------------------------------------------------ // Attempt to fill syndication resource //------------------------------------------------------------ XPathNavigator headNavigator = this.Navigator.SelectSingleNode("apml:APML/apml:Head", manager); if (headNavigator != null) { resource.Head.Load(headNavigator, this.Settings); } XPathNavigator bodyNavigator = this.Navigator.SelectSingleNode("apml:APML/apml:Body", manager); if (bodyNavigator != null) { if (bodyNavigator.HasAttributes) { string defaultProfileAttribute = bodyNavigator.GetAttribute("defaultprofile", String.Empty); if (!String.IsNullOrEmpty(defaultProfileAttribute)) { resource.DefaultProfileName = defaultProfileAttribute; } } XPathNodeIterator profileIterator = bodyNavigator.Select("apml:Profile", manager); if (profileIterator != null && profileIterator.Count > 0) { int counter = 0; while (profileIterator.MoveNext()) { ApmlProfile profile = new ApmlProfile(); counter++; if (profile.Load(profileIterator.Current, this.Settings)) { if (this.Settings.RetrievalLimit != 0 && counter > this.Settings.RetrievalLimit) { break; } ((Collection<ApmlProfile>)resource.Profiles).Add(profile); } } } XPathNodeIterator applicationIterator = bodyNavigator.Select("apml:Applications/apml:Application", manager); if (applicationIterator != null && applicationIterator.Count > 0) { while (applicationIterator.MoveNext()) { ApmlApplication application = new ApmlApplication(); if (application.Load(applicationIterator.Current, this.Settings)) { resource.Applications.Add(application); } } } } SyndicationExtensionAdapter adapter = new SyndicationExtensionAdapter(this.Navigator.SelectSingleNode("apml:APML", manager), this.Settings); adapter.Fill(resource, manager); }
/// <summary> /// Provides example code for the Save(Stream) method /// </summary> public static void SaveStreamExample() { #region Save(Stream stream) ApmlDocument document = new ApmlDocument(); // Modify document state using public properties and methods using(Stream stream = new FileStream("ApmlDocument.xml", FileMode.Create, FileAccess.Write)) { document.Save(stream); } #endregion }
/// <summary> /// Provides example code for the Save(XmlWriter) method /// </summary> public static void SaveXmlWriterExample() { #region Save(XmlWriter writer) ApmlDocument document = new ApmlDocument(); // Modify document state using public properties and methods using (Stream stream = new FileStream("ApmlDocument.xml", FileMode.Create, FileAccess.Write)) { XmlWriterSettings settings = new XmlWriterSettings(); settings.Indent = true; using(XmlWriter writer = XmlWriter.Create(stream, settings)) { document.Save(writer); } } #endregion }
/// <summary> /// Provides example code for the Load(Uri, ICredentials, IWebProxy) method /// </summary> public static void LoadUriExample() { #region Load(Uri source, ICredentials credentials, IWebProxy proxy) ApmlDocument document = new ApmlDocument(); Uri source = new Uri("http://aura.darkstar.sunlabs.com/AttentionProfile/apml/web/Oppositional"); document.Load(source, CredentialCache.DefaultNetworkCredentials, null); foreach (ApmlProfile profile in document.Profiles) { if (profile.Name == document.DefaultProfileName) { // Perform some processing on the attention profile break; } } #endregion }
/// <summary> /// Provides example code for the Load(XmlReader) method /// </summary> public static void LoadXmlReaderExample() { #region Load(XmlReader reader) ApmlDocument document = new ApmlDocument(); using (Stream stream = new FileStream("ApmlDocument.xml", FileMode.Open, FileAccess.Read)) { XmlReaderSettings settings = new XmlReaderSettings(); settings.IgnoreComments = true; settings.IgnoreWhitespace = true; using(XmlReader reader = XmlReader.Create(stream, settings)) { document.Load(reader); foreach (ApmlProfile profile in document.Profiles) { if (profile.Name == document.DefaultProfileName) { // Perform some processing on the attention profile break; } } } } #endregion }
/// <summary> /// Provides example code for the Load(Stream) method /// </summary> public static void LoadStreamExample() { #region Load(Stream stream) ApmlDocument document = new ApmlDocument(); using (Stream stream = new FileStream("ApmlDocument.xml", FileMode.Open, FileAccess.Read)) { document.Load(stream); foreach (ApmlProfile profile in document.Profiles) { if (profile.Name == document.DefaultProfileName) { // Perform some processing on the attention profile break; } } } #endregion }
//============================================================ // INSTANCE METHODS //============================================================ /// <summary> /// Provides example code for the Load(IXPathNavigable) method /// </summary> public static void LoadIXPathNavigableExample() { #region Load(IXPathNavigable source) XPathDocument source = new XPathDocument("http://aura.darkstar.sunlabs.com/AttentionProfile/apml/web/Oppositional"); ApmlDocument document = new ApmlDocument(); document.Load(source); foreach (ApmlProfile profile in document.Profiles) { if (profile.Name == document.DefaultProfileName) { // Perform some processing on the attention profile break; } } #endregion }
//============================================================ // ASYNC METHODS //============================================================ /// <summary> /// Provides example code for the LoadAsync(Uri, Object) method /// </summary> public static void LoadAsyncExample() { #region LoadAsync(Uri source, Object userToken) //------------------------------------------------------------ // Load resource asynchronously using event-based notification //------------------------------------------------------------ ApmlDocument document = new ApmlDocument(); document.Loaded += new EventHandler<SyndicationResourceLoadedEventArgs>(ResourceLoadedCallback); document.LoadAsync(new Uri("http://aura.darkstar.sunlabs.com/AttentionProfile/apml/web/Oppositional"), null); #endregion }
/// <summary> /// Instantiates a <see cref="ISyndicationResource"/> that conforms to the specified <see cref="SyndicationContentFormat"/> using the supplied <see cref="Stream"/>. /// </summary> /// <param name="stream">The <see cref="Stream"/> used to load the syndication resource.</param> /// <param name="format">A <see cref="SyndicationContentFormat"/> enumeration value that indicates the type syndication resource the <paramref name="stream"/> represents.</param> /// <returns> /// An <see cref="ISyndicationResource"/> object that conforms to the specified <paramref name="format"/>, initialized using the supplied <paramref name="stream"/>. /// If the <paramref name="format"/> is not supported by the provider, returns a <b>null</b> reference. /// </returns> /// <exception cref="ArgumentNullException">The <paramref name="stream"/> is a null reference (Nothing in Visual Basic).</exception> private static ISyndicationResource BuildResource(SyndicationContentFormat format, Stream stream) { //------------------------------------------------------------ // Validate parameters //------------------------------------------------------------ Guard.ArgumentNotNull(stream, "stream"); //------------------------------------------------------------ // Create syndication resource based on content format //------------------------------------------------------------ if (format == SyndicationContentFormat.Apml) { ApmlDocument document = new ApmlDocument(); document.Load(stream); return document; } else if (format == SyndicationContentFormat.Atom) { XPathDocument document = new XPathDocument(stream); XPathNavigator navigator = document.CreateNavigator(); navigator.MoveToRoot(); navigator.MoveToChild(XPathNodeType.Element); if(String.Compare(navigator.LocalName, "entry", StringComparison.OrdinalIgnoreCase) == 0) { AtomEntry entry = new AtomEntry(); entry.Load(navigator); return entry; } else if (String.Compare(navigator.LocalName, "feed", StringComparison.OrdinalIgnoreCase) == 0) { AtomFeed feed = new AtomFeed(); feed.Load(navigator); return feed; } else { return null; } } else if (format == SyndicationContentFormat.BlogML) { BlogMLDocument document = new BlogMLDocument(); document.Load(stream); return document; } else if (format == SyndicationContentFormat.Opml) { OpmlDocument document = new OpmlDocument(); document.Load(stream); return document; } else if (format == SyndicationContentFormat.Rsd) { RsdDocument document = new RsdDocument(); document.Load(stream); return document; } else if (format == SyndicationContentFormat.Rss) { RssFeed feed = new RssFeed(); feed.Load(stream); return feed; } else { return null; } }
/// <summary> /// Creates a new <see cref="ApmlDocument"/> instance using the specified <see cref="Uri"/>, <see cref="ICredentials"/>, <see cref="IWebProxy"/>, and <see cref="SyndicationResourceLoadSettings"/> object. /// </summary> /// <param name="source">A <see cref="Uri"/> that represents the URL of the syndication resource XML data.</param> /// <param name="options">A <see cref="WebRequestOptions"/> that holds options that should be applied to web requests.</param> /// <param name="settings">The <see cref="SyndicationResourceLoadSettings"/> object used to configure the <see cref="ApmlDocument"/> instance. This value can be <b>null</b>.</param> /// <returns>An <see cref="ApmlDocument"/> object loaded using the <paramref name="source"/> data.</returns> /// <exception cref="ArgumentNullException">The <paramref name="source"/> is a null reference (Nothing in Visual Basic).</exception> /// <exception cref="FormatException">The <paramref name="source"/> data does not conform to the expected syndication content format. In this case, the document remains empty.</exception> public static ApmlDocument Create(Uri source, WebRequestOptions options, SyndicationResourceLoadSettings settings) { //------------------------------------------------------------ // Local members //------------------------------------------------------------ ApmlDocument syndicationResource = new ApmlDocument(); //------------------------------------------------------------ // Validate parameters //------------------------------------------------------------ Guard.ArgumentNotNull(source, "source"); //------------------------------------------------------------ // Create new instance using supplied parameters //------------------------------------------------------------ syndicationResource.Load(source, options, settings); return syndicationResource; }