LocatorBase

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> tm4j >> [ net overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.tm4j.net
Class LocatorBase

java.lang.Object
  org.tm4j.net.LocatorBase

All Implemented Interfaces:: Locator, java.io.Serializable

public abstract class LocatorBase
extends java.lang.Object
implements Locator, java.io.Serializable

An abstract base class implementing the Locator interface.

Since:: 0.6.0

Field Summary

protected java.lang.String m_address
          The address of the resource which this locator represents.

protected LocatorFactory m_factory
          The locator factory associated with this locator.

protected java.lang.String m_notation
          This locator's notation.

Constructor Summary

LocatorBase()
          Creates an empty, uninitialized locator.

LocatorBase(Locator loc)
          Creates a locator from the given template, copying the original locator's notation and address.

LocatorBase(LocatorFactory factory)
          Creates a locator and associates it with the given factory.

LocatorBase(LocatorFactory factory, java.lang.String notation, java.lang.String address)
          Creates a complete, initialized locator.

Method Summary

java.lang.String getAddress()
          Gets the address associated with the locator

LocatorFactory getFactory()
          Returns the locator factory associated with this locator.

java.lang.String getNotation()
          Gets the string defining the notation type of this locator

void initialise(java.lang.String notation, java.lang.String address)
          Initializes the locator with the specified notation and address.

abstract boolean isSupportedNotation(java.lang.String notation)
          Determines whether the locator implementation supports the specified notation.

abstract java.lang.String normalizeAddress(java.lang.String address)
          Returns a normalized representation of the locator's address.

void setFactory(LocatorFactory factory)
          Associates the locator with the given factory.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.tm4j.net.Locator

copy, equals, hashCode, resolveRelative, resolveRelative

Field Detail

m_notation

protected java.lang.String m_notation

This locator's notation.

m_address

protected java.lang.String m_address

The address of the resource which this locator represents.

m_factory

protected LocatorFactory m_factory

The locator factory associated with this locator.

Constructor Detail

LocatorBase

public LocatorBase()

Creates an empty, uninitialized locator.

LocatorBase

public LocatorBase(LocatorFactory factory,
                   java.lang.String notation,
                   java.lang.String address)
            throws InvalidNotationException,
                   MalformedLocatorException

Creates a complete, initialized locator. This constructor is commonly invoked by factory classes implementing LocatorFactory.

LocatorBase

public LocatorBase(LocatorFactory factory)

Creates a locator and associates it with the given factory. This constructor is commonly invoked by factory classes implementing LocatorFactory and leaves the locator uninitialized. The factory class should subsequently invoke initialise(String, String) 55 .

LocatorBase

public LocatorBase(Locator loc)
            throws InvalidNotationException,
                   MalformedLocatorException

Creates a locator from the given template, copying the original locator's notation and address. This constructor does not associate the locator with any factory class.

Method Detail