Package net.ontopia.topicmaps.entry

Class URLTopicMapSource

  • All Implemented Interfaces:
    AutoCloseable, TopicMapSourceIF
    public class URLTopicMapSource
extends Object
implements TopicMapSourceIF
    INTERNAL: TopicMapSourceIF that can reference individual topic map documents by their URL address. The properties id, title, url, and syntax are the most commonly used. The syntaxes XTM, HyTM, and LTM are currently supported.

    Since:
    2.0

    • Constructor Detail

      • URLTopicMapSource

        public URLTopicMapSource()

      • URLTopicMapSource

        public URLTopicMapSource​(String url)

    • Method Detail

      • setId

        public void setId​(String id)
        Description copied from interface: TopicMapSourceIF
        PUBLIC: Sets the id of the source. Note that this method is intended for use when the source is used in a TopicMapRepositoryIF. The source should throw an UnsupportedOperationException if it does not support setting the id.

        Specified by:
        setId in interface TopicMapSourceIF

      • getReferenceId

        public String getReferenceId()
        INTERNAL: Gets the id of the topic map reference for this topic map source.

      • setReferenceId

        public void setReferenceId​(String refid)
        INTERNAL: Sets the id of the topic map reference for this topic map source.

      • getSyntax

        public String getSyntax()
        INTERNAL: Returns the syntax of the document.

      • setSyntax

        public void setSyntax​(String syntax)
        INTERNAL: Specifies the syntax of the document. This property will be used to ensure that the topic map syntax is correctly recognized. The supported syntaxes are 'XTM', 'HyTM', and 'LTM'. If the syntax is not specified the class will attempt to guess it by looking at the address suffix.

      • getUrl

        public String getUrl()
        INTERNAL: Gets the URL of the source topic map.

      • setUrl

        public void setUrl​(String url)
        INTERNAL: Sets the URL of the source topic map.

      • getBase

        public LocatorIF getBase()
        INTERNAL: Gets the base locator of the topic maps retrieved from the source.

      • setBase

        public void setBase​(LocatorIF base_address)
        INTERNAL: Sets the base locator of the topic maps retrieved from the source.

      • getBaseAddress

        public String getBaseAddress()
        INTERNAL: Gets the base address of the topic maps retrieved from the source. The notation is assumed to be 'URI'.

      • setBaseAddress

        public void setBaseAddress​(String base_address)
        INTERNAL: Sets the base address of the topic maps retrieved from the source. The notation is assumed to be 'URI'.

      • getDuplicateSuppression

        public boolean getDuplicateSuppression()
        INTERNAL: Gets the duplicate suppression flag. If the flag is true duplicate suppression is to be performed when loading the topic maps.

      • setDuplicateSuppression

        public void setDuplicateSuppression​(boolean duplicate_suppression)
        INTERNAL: Sets the duplicate suppression flag. If the flag is true duplicate suppression is to be performed when loading the topic maps.

      • setValidation

        public void setValidation​(boolean validate)
        INTERNAL: Turn validation of XTM documents according to DTD on or off. The validation checks if the documents read follow the DTD, and will abort import if they do not.
        Parameters:
        validate - Will validate if true, will not if false.

      • getValidation

        public boolean getValidation()
        INTERNAL: Returns true if validation is on, false otherwise.

      • setExternalReferenceHandler

        public void setExternalReferenceHandler​(ExternalReferenceHandlerIF ref_handler)
        INTERNAL: Sets the external reference handler.

      • getExternalReferenceHandler

        public ExternalReferenceHandlerIF getExternalReferenceHandler()
        INTERNAL: Gets the external reference handler. The reference handler will receive notifications on references to external topics and topic maps.

      • refresh

        public void refresh()
        Description copied from interface: TopicMapSourceIF
        PUBLIC: Refreshes the collection of references. This lets the source look at its underlying data source to reflect any changes made since the last refresh.
        Specified by:
        refresh in interface TopicMapSourceIF

      • close

        public void close()
        Description copied from interface: TopicMapSourceIF
        PUBLIC: Closes the source by releasing references it holds to e.g. database or file system objects.
        Specified by:
        close in interface AutoCloseable
        Specified by:
        close in interface TopicMapSourceIF

      • supportsCreate

        public boolean supportsCreate()
        Description copied from interface: TopicMapSourceIF
        PUBLIC: Returns true if the source supports creating new topic maps with the createTopicMap.
        Specified by:
        supportsCreate in interface TopicMapSourceIF

      • supportsDelete

        public boolean supportsDelete()
        Description copied from interface: TopicMapSourceIF
        PUBLIC: Returns true if the source supports deleting topic map with the TopicMapReferenceIF.delete() method.
        Specified by:
        supportsDelete in interface TopicMapSourceIF

      • createTopicMap

        public TopicMapReferenceIF createTopicMap​(String name,
                                          String baseAddress)
        Description copied from interface: TopicMapSourceIF
        PUBLIC: Creates a new topic map in the underlying source and returns a reference to the created topic map. The method takes a name and the base address for the topic map to create.
        Specified by:
        createTopicMap in interface TopicMapSourceIF

      • getHidden

        public boolean getHidden()

      • setHidden

        public void setHidden​(boolean hidden)