de.intarsys.tools.locator
Interface ILocator

All Superinterfaces:

de.intarsys.tools.component.ISynchronizable

All Known Implementing Classes:

ByteArrayLocator, ClassLoaderResourceLocator, ClassResourceLocator, CommonLocator, FileLocator, LocatorViewport, ReadOnlyLocator, StreamLocator, StringLocator, TransientLocator

public interface ILocator
extends de.intarsys.tools.component.ISynchronizable

The locator specifies the physical location of a resource.

Method Summary

void	delete() Delete the artifact referenced by this.
boolean	exists() Answer true if the location designated by this exists.
ILocator	getChild(String name) The locator for the resource name within the context of this.
String	getFullName() The full physical name of this.
InputStream	getInputStream() Return an InputStream on the data represented by the receiver.
String	getLocalName() The local name of the receiver within its parent.
OutputStream	getOutputStream() Return an OutputStream on the location represented by the receiver.
ILocator	getParent() The ILocator that is one hierarchy level up or null.
IRandomAccess	getRandomAccess() The IRandomAccess for this.
Reader	getReader() A Reader on the data represented by the receiver.
Reader	getReader(String encoding) A Reader on the data represented by the receiver for the given encoding.
String	getType() The type of the resource.
String	getTypedName() The qualified local name of the receiver within its parent that includes the type specification for the destination if appropriate.
Writer	getWriter() A Writer on the location represented by the receiver.
Writer	getWriter(String encoding) A Writer on the location represented by the receiver for the given encoding.
boolean	isDirectory() Answer true if the location designated by this is a directory.
boolean	isReadOnly() true if the specified resource is read only.
ILocator[]	listLocators(ILocatorNameFilter filter) Return an array of ILocator that are children of the receiver that conform to filter.
void	rename(String newName) Rename the complete physical name to newName.
void	setReadOnly() Make the receiver read only.
URL	toURL() The location designated by this as an URL.

Methods inherited from interface de.intarsys.tools.component.ISynchronizable

isOutOfSynch, isSynchSynchronous, synch

Method Detail

getChild

ILocator getChild(String name)

The locator for the resource name within the context of this. This may for example be an ILocator to a file within a directory.

Parameters:

name - The name of the resource to be located.

Returns:

The ILocator for the resource with the name "name" within the context of this.

isDirectory

boolean isDirectory()

Answer true if the location designated by this is a directory. A directory location serves as a container for other resources, you can never getInputStream on this.

Returns:

Answer true if the location designated by this is a directory.

getFullName

String getFullName()

The full physical name of this.

This method returns a representation that is proprietary to the underlying physical representation, for example a file name, a SQL statement or so on.

Returns:

The full physical name of the receiver.

getInputStream

InputStream getInputStream()
                           throws IOException

Return an InputStream on the data represented by the receiver.

Returns:

An InputStream on the data represented by the receiver.

Throws:

IOException

getLocalName

String getLocalName()

The local name of the receiver within its parent.

Returns:

The local name of the receiver within its parent.

getTypedName

String getTypedName()

The qualified local name of the receiver within its parent that includes the type specification for the destination if appropriate. This is for example a filename with its correct suffix. Some locator may return the same name as "getLocalName".

Returns:

The qualified local name of the receiver within its parent that includes the type specification for the destination if appropriate.

getOutputStream

OutputStream getOutputStream()
                             throws IOException

Return an OutputStream on the location represented by the receiver.

Returns:

An OutputStream on the location represented by the receiver.

Throws:

IOException

getParent

ILocator getParent()

The ILocator that is one hierarchy level up or null. This may be for example the directory where the currently designated resource is found.

Returns:

The ILocatorthat is one hierarchy level up or null.

getRandomAccess

IRandomAccess getRandomAccess()
                              throws IOException

The IRandomAccess for this.

Returns:

The IRandomAccess for this.

Throws:

IOException

getReader

Reader getReader()
                 throws IOException

A Reader on the data represented by the receiver.

Returns:

A Reader on the data represented by the receiver.

Throws:

IOException

getReader

Reader getReader(String encoding)
                 throws IOException

A Reader on the data represented by the receiver for the given encoding.

Parameters:

encoding - The encoding.

Returns:

A Reader on the data represented by the receiver for the given encoding.

Throws:

IOException

getType

String getType()

The type of the resource. This may be for example a mime type or the file extension of the underlying file.

Returns:

The type of the resource

getWriter

Writer getWriter()
                 throws IOException

A Writer on the location represented by the receiver.

Returns:

A Writer on the location represented by the receiver.

Throws:

IOException

getWriter

Writer getWriter(String encoding)
                 throws IOException

A Writer on the location represented by the receiver for the given encoding.

Parameters:

encoding - The encoding.

Returns:

A Writer on the location represented by the receiver for the given encoding.

Throws:

IOException

exists

boolean exists()

Answer true if the location designated by this exists.

Returns:

Answer true if the location designated by this exists.

listLocators

ILocator[] listLocators(ILocatorNameFilter filter)
                        throws IOException

Return an array of ILocator that are children of the receiver that conform to filter. This method never returns null.

Parameters:

filter - The filter used to examine the child resources.

Returns:

An array of ILocator objects that conform to the filter argument.

Throws:

IOException

toURL

URL toURL()

The location designated by this as an URL.

Returns:

The location designated by this as an URL.

isReadOnly

boolean isReadOnly()

true if the specified resource is read only.

Returns:

true if the specified resource is read only.

rename

void rename(String newName)
            throws IOException

Rename the complete physical name to newName.

Parameters:

newName - The new name of the ILocator. The new name is expected to contain both local and type part of the name.

Throws:

IOException

delete

void delete()
            throws IOException

Delete the artifact referenced by this.

Throws:

IOException

setReadOnly

void setReadOnly()

Make the receiver read only. This is a one way switch only.