Package xj3d.filter

Class CDFFilter

java.lang.Object

xj3d.filter.CDFFilter

public class CDFFilter
extends Object

General X3D filter driver. Takes an input file or URL, filters it and writes it out to a file.

Version:

$Revision: 1.57 $

Author:

Alan Hudson

Field Summary

Fields

Modifier and Type	Field	Description
static final int	IO_EXCEPTION	Exit code for an IO exception - use the PARSER_IOEXCEPTION_MSG.

Constructor Summary

Constructors

Constructor	Description
CDFFilter()	Create an instance of the demo class.

Method Summary

Modifier and Type	Method	Description
static int	executeFilters(String[] args, boolean exit, OutputStream ostream, String enc)	Execute a chain of filters.
int	filter(String[] filters, File file, OutputStream out, String enc, String[] fargs)	Load the named file.
int	filter(String[] filters, File file, String out, String[] fargs)	Load the named file.
int	filter(String[] filters, URL url, String out, String[] fargs)	Go to the named URL location.
static Map<String,String>	getFilterMap()	Return an unmodifiable Map of the locally known filters.
static void	main(String[] args)	Create an instance of this class and run it.
void	printFilters()	Print out the filters available.

Methods inherited from class java.lang.Object

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

Field Details

IO_EXCEPTION

public static final int IO_EXCEPTION

Exit code for an IO exception - use the PARSER_IOEXCEPTION_MSG.

See Also:

• Constant Field Values

Constructor Details

CDFFilter

public CDFFilter()

Create an instance of the demo class.

Method Details

filter

public int filter(String[] filters,
 URL url,
 String out,
 String[] fargs)

Go to the named URL location. No checking is done other than to make sure it is a valid URL.

Parameters:

filters - The identifier of the filter type.

url - The URL to open.

out - The output filename.

fargs - The argument array to pass into the filter class.

Returns:

The status code indicating success or failure.

filter

public int filter(String[] filters,
 File file,
 String out,
 String[] fargs)

Load the named file. The file is checked to make sure that it exists before calling this method.

Parameters:

filters - The identifier of the filter type.

file - The file to load.

out - The output filename.

fargs - The argument array to pass into the filter class.

Returns:

The status code indicating success or failure.

filter

public int filter(String[] filters,
 File file,
 OutputStream out,
 String enc,
 String[] fargs)

Load the named file. The file is checked to make sure that it exists before calling this method.

Parameters:

filters - The identifier of the filter type.

file - The file to load.

out - The output stream

enc - The encoding to write

fargs - The argument array to pass into the filter class.

Returns:

The status code indicating success or failure.

printFilters

public void printFilters()

Print out the filters available.

getFilterMap

public static Map<String,String> getFilterMap()

Return an unmodifiable Map of the locally known filters.

Returns:

An unmodifiable Map of the locally known filters.

executeFilters

public static int executeFilters(String[] args,
 boolean exit,
 OutputStream ostream,
 String enc)

Execute a chain of filters.

Parameters:

args - The list of arguments for this application.

exit - Should we use system exit

ostream - If present output to this stream instead of a file

enc - If ostream is used this specifies the encoding otherwise it's ignored.

Returns:

The exit code

main

public static void main(String[] args)

Create an instance of this class and run it. The single argument, if supplied is the name of the file to load initially. If not supplied it will start with a blank document.

Parameters:

args - The list of arguments for this application.