Package net.ontopia.infoset.impl.basic

Class URILocator

java.lang.Object
net.ontopia.infoset.impl.basic.URILocator
All Implemented Interfaces:
Externalizable, Serializable, LocatorIF
Direct Known Subclasses:
RDBMSLocator
public class URILocator extends Object implements LocatorIF, Externalizable
PUBLIC: A Uniform Resource Identifier locator. Only URI locators should be used with this locator class. The notation is 'URI'.

The address is always normalized by the constructor. The address given to the constructor must be absolute.

See Also:

  • Field Details

  • Constructor Details

    • URILocator

      public URILocator()
      INTERNAL: No-argument constructor used by serialization. Do not use this constructor in application code.

    • URILocator

      public URILocator(String address) throws URISyntaxException
      PUBLIC: Creates a URILocator representing the URI given. Note that the URI string should be in external form, and that it must be absolute.
      Throws:
      URISyntaxException

    • URILocator

      public URILocator(URL url)
      PUBLIC: Creates a URILocator representing the URL given.

    • URILocator

      public URILocator(File file)
      PUBLIC: Creates a URILocator containing a file URL referring to the file represented by the File object.

      Since:
      1.3.4

  • Method Details

    • getNotation

      public String getNotation()
      Description copied from interface: LocatorIF
      PUBLIC: Gets the locator notation. The default notation is URI. Ontopia will never use notation names which begin with 'x-'. Notation names are case-insensitive.

      Note that only the URI notation is supported in release OKS 4.0 and newer.

      Specified by:
      getNotation in interface LocatorIF

    • getAddress

      public String getAddress()
      Description copied from interface: LocatorIF
      PUBLIC: Returns the locator address in absolute and normalized form. Whether addresses are case-sensitive or not depends on the locator notation.
      Specified by:
      getAddress in interface LocatorIF

    • resolveAbsolute

      public LocatorIF resolveAbsolute(String rel)
      Description copied from interface: LocatorIF
      PUBLIC: Given a locator address string that is relative to this locator, return an absolute locator. If the input locator address is absolute the returned locator object will simply contain that absolute locator address.
      Specified by:
      resolveAbsolute in interface LocatorIF

    • getExternalForm

      public String getExternalForm()
      Description copied from interface: LocatorIF
      PUBLIC: Returns the address of the locator in external form; that is, with special characters that need to be escaped escaped using the escape syntax of the locator notation.
      Specified by:
      getExternalForm in interface LocatorIF

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object object)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getUri

      public URI getUri()
      INTERNAL: returns the internal URI state of this locator.

    • writeExternal

      public void writeExternal(ObjectOutput out) throws IOException
      Specified by:
      writeExternal in interface Externalizable
      Throws:
      IOException

    • readExternal

      public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
      Specified by:
      readExternal in interface Externalizable
      Throws:
      IOException
      ClassNotFoundException

    • create

      public static URILocator create(String uriAddress)
      PUBLIC: Parses the URI and returns an instance of URILocator if the URI is valid. If the URI is invalid null is returned.
      Since:
      3.0