org.gvsig.gpe.lib.spi

Interface GPEProviderManager

All Known Implementing Classes:

DefaultGPEProviderManager

public interface GPEProviderManager

Method Summary

Modifier and Type	Method and Description
boolean	accept(java.net.URI uri) Return true if exists a driver that can open the file
void	addGpeParser(java.lang.Class clazz) Adds a new GPE parser
void	addGpeParser(java.lang.String name, java.lang.String description, java.lang.Class clazz) Adds a new GPE parser
void	addGpeWriterHandlerImplementor(java.lang.Class clazz) Adds a new GPEWriterHandlerImplementor
void	addGpeWriterHandlerImplementor(java.lang.String name, java.lang.String description, java.lang.Class clazz) Adds a new GPEWriterHandlerImplementor
void	addParsersFile(java.io.File file) It loads the parsers of a parsers file.
void	addWritersFile(java.io.File file) It loads the writers of a writers file.
IGPEParser	createParser(java.io.File file) Gets the parser that can open the file (if it exists)
IGPEParser	createParser(java.lang.String name) Create a new parser from a name
IGPEParser	createParser(java.net.URI uri) Gets the parser that can open the file (if it exists)
IGPEParser	createParserByClass(java.lang.String prefferredImplClassName) Create a new parser from a name
IGPEParser	createParserByMimeType(java.lang.String mimeType) Create a new parser from a mime type.
IGPEWriterHandlerImplementor	createWriterHandlerImplementor(java.lang.String name) Create a new content writer from a name
IGPEWriterHandlerImplementor	createWriterHandlerImplementorByClass(java.lang.String prefferredImplClassName) Create a new writer from a class name.
IGPEWriterHandlerImplementor	createWriterHandlerImplementorByMimeType(java.lang.String mimeType) Create a new writer from a mime type.
IGPEParser[]	getAllParsers()
java.util.ArrayList	getWriterHandlerByFormat(java.lang.String format) Gets all the writers that can write the provided format.

Method Detail

addGpeParser

void addGpeParser(java.lang.String name,
                  java.lang.String description,
                  java.lang.Class clazz)
           throws ParserNotRegisteredException

Adds a new GPE parser

Parameters:

name - Driver name. It must be written like FORMAT VERSION

description - Driver description. Just a descriptive text

clazz - The parser class

Throws:

ParserNotRegisteredException

GPEParserRegisterException

addGpeParser

void addGpeParser(java.lang.Class clazz)
           throws ParserNotRegisteredException

Adds a new GPE parser

Parameters:

clazz - The parser class

Throws:

ParserNotRegisteredException

GPEParserRegisterException

addParsersFile

void addParsersFile(java.io.File file)
             throws java.io.FileNotFoundException,
                    java.io.IOException

It loads the parsers of a parsers file. The file is a properties file. Every line has the structure: Parser=Parser class

Parameters:

file - File that contains the parsers list

Throws:

java.io.IOException

java.io.FileNotFoundException

ParserNotRegisteredException

addWritersFile

void addWritersFile(java.io.File file)
             throws java.io.FileNotFoundException,
                    java.io.IOException

It loads the writers of a writers file. The file is a properties file. Every line has the structure: Writer=Parser class

Parameters:

file - File that contains the writers list

Throws:

java.io.IOException

java.io.FileNotFoundException

getAllParsers

IGPEParser[] getAllParsers()

Returns:

all the registered parsers

addGpeWriterHandlerImplementor

void addGpeWriterHandlerImplementor(java.lang.String name,
                                    java.lang.String description,
                                    java.lang.Class clazz)
                             throws WriterHandlerNotRegisteredException

Adds a new GPEWriterHandlerImplementor

Parameters:

name - Driver name. It must be written like FORMAT VERSION

description - Driver description. Just a descriptive text

clazz - The parser class

Throws:

WriterHandlerNotRegisteredException

GPEWriterHandlerRegisterException

addGpeWriterHandlerImplementor

void addGpeWriterHandlerImplementor(java.lang.Class clazz)
                             throws WriterHandlerNotRegisteredException

Adds a new GPEWriterHandlerImplementor

Parameters:

clazz - The parser class

Throws:

WriterHandlerNotRegisteredException

GPEWriterHandlerRegisterException

createParser

IGPEParser createParser(java.lang.String name)
                 throws ParserCreationException

Create a new parser from a name

Parameters:

name - GPEParser name

contenHandler - Application contenHandler usett to throw the parsing events

errorHandler - Application errror handler used to put errors and warnings

Throws:

ParserCreationException

GPEParserCreationException

createParserByClass

IGPEParser createParserByClass(java.lang.String prefferredImplClassName)
                        throws ParserCreationException

Create a new parser from a name

Parameters:

name - GPEParser name

contenHandler - Application contenHandler usett to throw the parsing events

errorHandler - Application errror handler used to put errors and warnings

Throws:

ParserCreationException

GPEParserCreationException

createParserByMimeType

IGPEParser createParserByMimeType(java.lang.String mimeType)
                           throws ParserCreationException

Create a new parser from a mime type. Each parser has a method named GPEParser#getFormat() that returns the mimetype that the parser can read. One parser only supports one mimetype.

This method retrieve all the parsers and returns the first parser that is able to read the mimetype. If there are more parsers that can open the file will not be used.

Parameters:

mimeType - The mimetype of the file to open

Returns:

A parser that can parse the mimetype.

Throws:

ParserCreationException - If it is not possible to create a parser

See Also:

http://www.iana.org/assignments/media-types/

createParser

IGPEParser createParser(java.net.URI uri)
                 throws ParserCreationException

Gets the parser that can open the file (if it exists)

Parameters:

uri - File to open

Returns:

Null if the driver doesn't exist

Throws:

GPEParserCreationException

java.lang.NoSuchMethodException

java.lang.reflect.InvocationTargetException

java.lang.IllegalAccessException

java.lang.InstantiationException

java.lang.SecurityException

java.lang.IllegalArgumentException

ParserCreationException

createParser

IGPEParser createParser(java.io.File file)
                 throws ParserCreationException

Gets the parser that can open the file (if it exists)

Parameters:

file - File to open

Returns:

Null if the driver doesn't exist

Throws:

GPEParserCreationException

java.lang.NoSuchMethodException

java.lang.reflect.InvocationTargetException

java.lang.IllegalAccessException

java.lang.InstantiationException

java.lang.SecurityException

java.lang.IllegalArgumentException

ParserCreationException

createWriterHandlerImplementor

IGPEWriterHandlerImplementor createWriterHandlerImplementor(java.lang.String name)
                                                     throws WriterHandlerCreationException

Create a new content writer from a name

Parameters:

name - GPEWriterHandler name GPEParser name

contenHandler - Application contenHandler usett to throw the parsing events

errorHandler - Application errror handler used to put errors and warnings

Throws:

GPEWriterHandlerCreationException

WriterHandlerCreationException

createWriterHandlerImplementorByClass

IGPEWriterHandlerImplementor createWriterHandlerImplementorByClass(java.lang.String prefferredImplClassName)
                                                            throws WriterHandlerCreationException

Create a new writer from a class name. This method can be used if the class name is known but, the common method to get a writer is using the mime type. *

Parameters:

prefferredImplClassName - The name of the class that implements GPEWriterHandler

Returns:

A writer for a concrete format.

Throws:

WriterHandlerCreationException - If it is not possible to create a writer

createWriterHandlerImplementorByMimeType

IGPEWriterHandlerImplementor createWriterHandlerImplementorByMimeType(java.lang.String mimeType)
                                                               throws WriterHandlerCreationException

Create a new writer from a mime type. Each writer has a method named GPEWriterHandler#getFormat() that returns the mimetype that the writer can write. One writer only supports one mimetype.

This method retrieve all the writers and returns the first one that is able to write the mimetype. If there are more writer that can write the format will not be used.

Parameters:

mimeType - The mimetype of the file to write

Returns:

A writer that can write the mimetype.

Throws:

WriterHandlerCreationException - If it is not possible to create a writer

See Also:

http://www.iana.org/assignments/media-types/

getWriterHandlerByFormat

java.util.ArrayList getWriterHandlerByFormat(java.lang.String format)

Gets all the writers that can write the provided format. The elements are of type IGPEWriterHandler

Parameters:

format - as a short form (without version). Example: "gml", "kml"

Returns:

accept

boolean accept(java.net.URI uri)

Return true if exists a driver that can open the file

Parameters:

uri - File to open

Returns:

true if the driver exists