org.mmbase.framework.basic

Class DirectoryUrlConverter

java.lang.Object

org.mmbase.framework.basic.BlockUrlConverter

org.mmbase.framework.basic.DirectoryUrlConverter

All Implemented Interfaces:

Serializable, UrlConverter

Direct Known Subclasses:

MMBaseUrlConverter, MyNewsUrlConverter

public abstract class DirectoryUrlConverter
extends BlockUrlConverter

A directory URL converter is a URL-converter which arranges to work in just one subdirectory. In stead of BlockUrlConverter.getUrl(java.lang.String, java.util.Map<java.lang.String, ?>, org.mmbase.util.functions.Parameters, boolean, boolean) and BlockUrlConverter.getInternalUrl(java.lang.String, java.util.Map<java.lang.String, ?>, org.mmbase.util.functions.Parameters) you override getNiceDirectoryUrl(java.lang.StringBuilder, org.mmbase.framework.Block, org.mmbase.util.functions.Parameters, org.mmbase.util.functions.Parameters, boolean) and getFilteredInternalDirectoryUrl(java.util.List<java.lang.String>, java.util.Map<java.lang.String, ?>, org.mmbase.util.functions.Parameters). It is also assumed that the niceness of the URL's is basicly about one block.

Since:

MMBase-1.9

Version:

$Id$

Author:

Michiel Meeuwissen

See Also:

Serialized Form

To Do:

EXPERIMENTAL

Field Summary

Fields inherited from class org.mmbase.framework.basic.BlockUrlConverter

blocks, components, framework

Constructor Summary

Constructors

Constructor and Description
DirectoryUrlConverter(BasicFramework fw)

Method Summary

Modifier and Type	Method and Description
int	getDefaultWeight()
String	getDirectory() The 'directory' used for thie UrlConverter.
Pattern	getDomain() A regular expression witch must match 'getLocalName' of the request for this UrlConverter to match.
protected abstract Url	getFilteredInternalDirectoryUrl(List<String> path, Map<String,?> params, Parameters frameworkParameters)
Url	getFilteredInternalUrl(String pa, Map<String,?> params, Parameters frameworkParameters) When implementing this method you can assume that you don't have to return Url.NOT.
protected abstract void	getNiceDirectoryUrl(StringBuilder b, Block block, Parameters parameters, Parameters frameworkParameters, boolean action) This is the method you must implement.
protected Url	getNiceUrl(Block block, Parameters parameters, Parameters frameworkParameters, boolean action) When implementing this method, you can already assume that the url must be 'nice', iow that we are actually rendering in the 'realm' of this UrlConverter, and you can straightforwardly, withough any checking, produce the URL.
protected List<String>	getPath(String pa)
boolean	isFilteredMode(Parameters frameworkParameters) Whether the current request already is in the realm of this URL-converter; the url converter must implement here how it recognizes itself.
static void	main(String[] argv)
void	setDirectory(String d)
void	setDomain(String d)
String	toString()

Methods inherited from class org.mmbase.framework.basic.BlockUrlConverter

addBlock, addComponent, getBlock, getBlocks, getComponents, getExplicitBlock, getInternalUrl, getParameterDefinition, getProcessUrl, getState, getUrl, getUrl

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryUrlConverter

public DirectoryUrlConverter(BasicFramework fw)

Method Detail

setDirectory

public void setDirectory(String d)

setDomain

public void setDomain(String d)

Since:

MMBase-1.9.2

getDirectory

public String getDirectory()

The 'directory' used for thie UrlConverter. A String which begins and ends with '/'.

getDomain

public Pattern getDomain()

A regular expression witch must match 'getLocalName' of the request for this UrlConverter to match. This defaults to .*.

Since:

MMBase-1.9.2

getDefaultWeight

public int getDefaultWeight()

Specified by:

getDefaultWeight in interface UrlConverter

Overrides:

getDefaultWeight in class BlockUrlConverter

getNiceUrl

protected final Url getNiceUrl(Block block,
                               Parameters parameters,
                               Parameters frameworkParameters,
                               boolean action)
                        throws FrameworkException

Description copied from class: BlockUrlConverter

When implementing this method, you can already assume that the url must be 'nice', iow that we are actually rendering in the 'realm' of this UrlConverter, and you can straightforwardly, withough any checking, produce the URL.

Specified by:

getNiceUrl in class BlockUrlConverter

Parameters:

block - Block for which the produce the url for

parameters - Parameters to use for this block. The implementation may set parameters to null which were represented in the returning String.

Throws:

FrameworkException

getPath

protected List<String> getPath(String pa)

getNiceDirectoryUrl

protected abstract void getNiceDirectoryUrl(StringBuilder b,
                                            Block block,
                                            Parameters parameters,
                                            Parameters frameworkParameters,
                                            boolean action)
                                     throws FrameworkException

This is the method you must implement. Append the nice URL to b. b already ends with <directory>/

Throws:

FrameworkException

isFilteredMode

public boolean isFilteredMode(Parameters frameworkParameters)
                       throws FrameworkException

Description copied from class: BlockUrlConverter

Whether the current request already is in the realm of this URL-converter; the url converter must implement here how it recognizes itself.

Specified by:

isFilteredMode in interface UrlConverter

Specified by:

isFilteredMode in class BlockUrlConverter

Throws:

FrameworkException

getFilteredInternalUrl

public final Url getFilteredInternalUrl(String pa,
                                        Map<String,?> params,
                                        Parameters frameworkParameters)
                                 throws FrameworkException

Description copied from class: BlockUrlConverter

When implementing this method you can assume that you don't have to return Url.NOT. IOW it is certain that the current URL is 'nice' according to this URL Converter.

Specified by:

getFilteredInternalUrl in class BlockUrlConverter

Throws:

FrameworkException

getFilteredInternalDirectoryUrl

protected abstract Url getFilteredInternalDirectoryUrl(List<String> path,
                                                       Map<String,?> params,
                                                       Parameters frameworkParameters)
                                                throws FrameworkException

Throws:

FrameworkException

toString

public String toString()

Overrides:

toString in class Object

main

public static void main(String[] argv)