org.qedeq.kernel.se.common
Interface ModuleAddress

All Known Implementing Classes:

DefaultModuleAddress

public interface ModuleAddress

An address for a QEDEQ module.

Author:

Michael Meyling

Method Summary

ModuleContext	createModuleContext() Get module address as ModuleContext.
java.lang.String	getFileName() Get module file name.
java.lang.String	getHeader() Get address header (including protocol, host, port, user) but without file path.
ModuleAddress[]	getModulePaths(Specification spec) Get all potential module addresses from a module specification.
java.lang.String	getName() Get name of module (file name without .xml).
java.lang.String	getPath() Get address path (without protocol, host, port and file name).
java.lang.String	getUrl() Get fully qualified URL of module.
boolean	isFileAddress() Is this a local QEDEQ file.
boolean	isRelativeAddress() Was this module address created relatively?

Method Detail

createModuleContext

ModuleContext createModuleContext()

Get module address as ModuleContext. Creates a new object.

Returns:

Module address as ModuleContext.

getHeader

java.lang.String getHeader()

Get address header (including protocol, host, port, user) but without file path.

Returns:

address header

getPath

java.lang.String getPath()

Get address path (without protocol, host, port and file name).

Returns:

module path

getFileName

java.lang.String getFileName()

Get module file name.

Returns:

Module file name.

getName

java.lang.String getName()

Get name of module (file name without .xml).

Returns:

Module name.

getUrl

java.lang.String getUrl()

Get fully qualified URL of module.

Returns:

URL for QEDEQ module.

isRelativeAddress

boolean isRelativeAddress()

Was this module address created relatively?

Returns:

Relatively created?

isFileAddress

boolean isFileAddress()

Is this a local QEDEQ file. That means the address starts with file:.

Returns:

Is the QEDEQ module a local file?

getModulePaths

ModuleAddress[] getModulePaths(Specification spec)
                               throws java.io.IOException

Get all potential module addresses from a module specification. TODO mime 20070326: add context information (for error case)

Parameters:

spec - Here are the (perhaps relative) addresses to another module.

Returns:

Array of absolute address strings.

Throws:

java.io.IOException - One address is not correctly formed.