Project

Profile

Help

Revision 2cd2299c

Added by O'Neil Delpratt 2 months ago

Added documentation to Saxon.NET classes #4839

View differences:

src/main/csharp/api/Saxon.Api/Extensibility.cs
544 544

  
545 545
        JStandardCollectionFinder collectionFinder;
546 546

  
547
        /// <summary>
548
        /// Default constructor to create a wrapped Java StandardCollectionFinder
549
        /// </summary>
547 550
        public StandardCollectionFinder() {
548 551
            collectionFinder = new JStandardCollectionFinder();
549 552
        }
......
674 677
    }
675 678

  
676 679
	/// <summary>
677
	/// ResourceCollection
680
	/// ResourceCollection class implements the IResourcecollection interface.
681
    /// This class is used to map the URI of collection into a sequence of Resource objects.
682
    /// It is usedto support the fn:collection() and fn:uri-collection() functions.
678 683
	/// </summary>
679 684
    public class ResourceCollection : IResourceCollection
680 685
    {
......
689 694
            resourceCollection = rc;
690 695
        }
691 696

  
697
        /// <summary>
698
        /// Get the URI of the collection
699
        /// </summary>
700
        /// <returns>The URI as passed to the fn:collection() or fn:uri-collection() function, resolved if it is relative
701
        /// against the static base URI. If the collection() or uri-collection() function was called with no argument (to get the 
702
        /// 'default collection') this will be the URI of the default collection registered with the Configuration</returns>
692 703
        public string CollectionURI()
693 704
        {
694 705
            return resourceCollection.getCollectionURI();
695 706
        }
696 707

  
708
        /// <summary>
709
        /// Get the URIs of the resources in the collection.  It is
710
        /// not required that all collections expose a list of URIs in this way, or that the URIs bear any particular
711
        /// relationship to the resources returned by the getResources() method for the same collection URI.
712
        /// </summary>
713
        /// <param name="context">the XPath evaluation context</param>
714
        /// <returns>List over the URIs of the resources in the collection. The URIs are represented as strings.
715
        /// They should preferably be absolute URIs.</returns>
697 716
        public List<string> GetResourceURIs(DynamicContext context)
698 717
        {
699 718
            List<string> list = new List<string>();
......
706 725
            return list;
707 726
        }
708 727

  
728
        /// <summary>
729
        /// Get the resources in the collection. This supports the fn:collection() function. It is not
730
        /// required that all collections expose a set of resources in this way, or that the resources
731
        /// returned bear any particular relationship to the URIs returned by the getResourceURIs() method
732
        /// for the same collection URI.
733
        /// </summary>
734
        /// <param name="context">context the XPath evaluation context</param>
735
        /// <returns>a list over the resources in the collection. This returns objects of implementations of the interface <code>IResource</code></returns>
709 736
        public List<IResource> GetResources(DynamicContext context)
710 737
        {
711 738
            List<IResource> list = new List<IResource>();
......
764 791
    {
765 792
        internal JResource resource = null;
766 793

  
794
        //Default constructor
767 795
        public Resource() 
768 796
		{ 
769 797
			resource = null; 
770 798
		}
771 799

  
800
        /// <summary>
801
        /// Constructor to  wrap a Java Resource
802
        /// </summary>
803
        /// <param name="rc">Java Resource object</param>
772 804
        public Resource(JResource rc) 
773 805
		{
774 806
            resource = rc;
775 807
        }
776 808

  
809
        /// <summary>
810
        /// Get the media type (MIME type) of the resource if known
811
        /// </summary>
812
        /// <returns>the media type if known; otherwise null</returns>
777 813
        public string GetContentType()
778 814
        {
779 815
            return resource.getContentType();
780 816
        }
781 817

  
818
        /// <summary>
819
        /// Get a URI that identifies this resource
820
        /// </summary>
821
        /// <returns>a URI identifying this resource</returns>
782 822
        public string GetResourceURI()
783 823
        {
784 824
            return resource.getResourceURI();

Also available in: Unified diff