net.sourceforge.czt.session

Class SourceLocator

java.lang.Object

net.sourceforge.czt.session.AbstractCommand

net.sourceforge.czt.session.SourceLocator

All Implemented Interfaces:

Command

public class SourceLocator
extends AbstractCommand

A command to compute the URL for a Z section. This first looks for /lib/name.tex in the CZT sources, then searches for a variety of file extensions in the directory specified by czt.path.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SourceLocator.SourceLocatorException Exception thrown when source could not be found.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_CZT_PATH

Constructor Summary

Constructors

Constructor and Description
SourceLocator()

Method Summary

Modifier and Type	Method and Description
static void	addCZTPathFor(File file, SectionManager manager)
protected boolean	doCompute(String name, SectionManager manager) Tries to locate the resource named for the given section manager.
static String	extractPath(String filename) For a file "./dir/foo.ext" or ".\dir\foo.ext", extracts the path such that the result is "./dir/".
static String	getCZTPathFor(File file, SectionManager manager)
static String	getFileNameNoExt(String filename) For a file "./dir/foo.ext", returns "./dir/foo".
static String	getSourceName(String filename) Get the CZT Source name from a given file.
protected URL	locateToolkit(String name) Locates the given name as a toolkit within CZT.jar /lib/name.tex
protected URL	locateToolkitForClass(Class<?> sourceClass, String name)
static List<String>	processCZTPaths(String path) Very simple path splitting through path.split(File.pathSeparator).
static String	removePath(String filename) For a file "./dir/foo.ext" or ".\dir\foo.ext", removes the path such that the result is "foo.ext".
static Properties	retrieveCZTProperties(Dialect d) Retrieve the czt.properties file within user.dir or "."

Methods inherited from class net.sourceforge.czt.session.AbstractCommand

compute, processProperties, traceInfo, traceLog

Methods inherited from class java.lang.Object

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

Field Detail

PROP_CZT_PATH

public static final String PROP_CZT_PATH

See Also:

Constant Field Values

Constructor Detail

SourceLocator

public SourceLocator()

Method Detail

locateToolkit

protected URL locateToolkit(String name)

Locates the given name as a toolkit within CZT.jar /lib/name.tex

Parameters:

name -

Returns:

URL for name

locateToolkitForClass

protected URL locateToolkitForClass(Class<?> sourceClass,
                                    String name)

doCompute

protected boolean doCompute(String name,
                            SectionManager manager)
                     throws CommandException

Tries to locate the resource named for the given section manager. The lookup algorithm for name as follows :

1. checks if is a toolkit within czt.jar!/lib/name.tex
2. checks under current directory as ./name.suffixes, where the sufixes include all possible values allowed (e.g., .tex, .zed, .oz, .zed8, .zml, .circus, etc)
3. checks for czt.path within SectionManager properties:
   1. if availble, looks for czt.path/name.suffixes;
   2. otherwise, looks for czt.path within user.dir/czt.properties
4. checks if user.dir/czt.properties has czt.path within it, and if so, checks its value with name.suffixes.

The first successful check in this order wins. If none work, a SourceLocatorException is raised with the latest calculated path and the name as additional information. Note that czt.path can be a semicolon-separated list of paths looked in FIFO order. That means, if a file is found at an earlier directory, that is the one used.

Specified by:

doCompute in class AbstractCommand

Parameters:

name - the resource we are trying to locate.

manager - the manager requesting the resource.

Returns:

true if resource found, raises an exception otherwise.

Throws:

CommandException - if resource not found.

retrieveCZTProperties

public static Properties retrieveCZTProperties(Dialect d)
                                        throws CommandException

Retrieve the czt.properties file within user.dir or "."

Returns:

the properties file containing information from czt.properties, or null if not found.

Throws:

CommandException - if czt.properties cannot be processed

processCZTPaths

public static List<String> processCZTPaths(String path)

Very simple path splitting through path.split(File.pathSeparator). Any more complicated behaviour can be defined differently elsewhere.

Parameters:

path - the string to split, it expects the path to be non-null and non-empty

Returns:

a list of paths to search for files

removePath

public static String removePath(String filename)

For a file "./dir/foo.ext" or ".\dir\foo.ext", removes the path such that the result is "foo.ext". If "foo.ext" is given, it is directly returned.

Parameters:

filename - full file name to remove path

Returns:

file name with path removed

extractPath

public static String extractPath(String filename)

For a file "./dir/foo.ext" or ".\dir\foo.ext", extracts the path such that the result is "./dir/". If "foo.ext" is given, "./" is returned.

Parameters:

filename - full file name to remove path

Returns:

path from file name

getFileNameNoExt

public static String getFileNameNoExt(String filename)

For a file "./dir/foo.ext", returns "./dir/foo". If no extension is present, the filename given is returned.

Parameters:

filename - full file name to remove extension

Returns:

filename without extension

getSourceName

public static String getSourceName(String filename)

Get the CZT Source name from a given file. It removes the path for the file name without extension.

Parameters:

filename -

Returns:

getCZTPathFor

public static String getCZTPathFor(File file,
                                   SectionManager manager)

addCZTPathFor

public static void addCZTPathFor(File file,
                                 SectionManager manager)