org.apache.directory.api.ldap.schema.converter

Class SchemaParser

java.lang.Object

org.apache.directory.api.ldap.schema.converter.SchemaParser

public class SchemaParser
extends java.lang.Object

A reusable wrapper for antlr generated schema parsers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	SchemaParser.DataProducer The thread which read the schema files and fill the temporary buffer used by the lexical analyzer.

Field Summary

Fields

Modifier and Type	Field and Description
private byte[]	buf A temporary buffer storing the read schema bytes
private antlrSchemaConverterParser	parser The antlr generated parser
private java.io.PipedOutputStream	parserIn A pipe into the parser
private java.lang.Thread	producerThread The thread used to read the schema
private java.io.InputStream	schemaIn The inputStream mapped over the schema file to parse

Constructor Summary

Constructors

Constructor and Description
SchemaParser() Creates a reusable instance of an SchemaParser.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear the parser.
void	init() Initializes a parser and its plumbing.
private java.util.List<SchemaElement>	invokeParser(java.lang.String schemaName) Invoke the parser
void	parse(java.io.File schemaFile) Thread safe method parses a file of OpenLDAP schemaObject elements/objects.
java.util.List<SchemaElement>	parse(java.io.InputStream schemaIn) Thread safe method parses a stream of OpenLDAP schemaObject elements/objects.
java.util.List<SchemaElement>	parse(java.lang.String schemaObject) Thread safe method parses an OpenLDAP schemaObject element/object.

Methods inherited from class java.lang.Object

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

Field Detail

parser

private antlrSchemaConverterParser parser

The antlr generated parser

parserIn

private java.io.PipedOutputStream parserIn

A pipe into the parser

buf

private byte[] buf

A temporary buffer storing the read schema bytes

schemaIn

private java.io.InputStream schemaIn

The inputStream mapped over the schema file to parse

producerThread

private java.lang.Thread producerThread

The thread used to read the schema

Constructor Detail

SchemaParser

public SchemaParser()
             throws java.io.IOException

Creates a reusable instance of an SchemaParser.

Throws:

java.io.IOException - if the pipe cannot be formed

Method Detail

init

public void init()
          throws java.io.IOException

Initializes a parser and its plumbing.

Throws:

java.io.IOException - if a pipe cannot be formed.

clear

public void clear()

Clear the parser.

parse

public java.util.List<SchemaElement> parse(java.lang.String schemaObject)
                                    throws java.io.IOException,
                                           java.text.ParseException

Thread safe method parses an OpenLDAP schemaObject element/object.

Parameters:

schemaObject - the String image of a complete schema object

Returns:

The list of parsed schema elements

Throws:

java.io.IOException - If the schema file can't be processed

java.text.ParseException - If we weren't able to parse the schema

invokeParser

private java.util.List<SchemaElement> invokeParser(java.lang.String schemaName)
                                            throws java.io.IOException,
                                                   java.text.ParseException

Invoke the parser

Parameters:

schemaName - The schema to be parsed

Returns:

A list of schema elements

Throws:

java.io.IOException - If the schema file can't be processed

java.text.ParseException - If we weren't able to parse the schema

parse

public java.util.List<SchemaElement> parse(java.io.InputStream schemaIn)
                                    throws java.io.IOException,
                                           java.text.ParseException

Thread safe method parses a stream of OpenLDAP schemaObject elements/objects.

Parameters:

schemaIn - a stream of schema objects

Returns:

A list of schema elements

Throws:

java.io.IOException - If the schema file can't be processed

java.text.ParseException - If we weren't able to parse the schema

parse

public void parse(java.io.File schemaFile)
           throws java.io.IOException,
                  java.text.ParseException

Thread safe method parses a file of OpenLDAP schemaObject elements/objects.

Parameters:

schemaFile - a file of schema objects

Throws:

java.io.IOException - If the schema file can't be processed

java.text.ParseException - If we weren't able to parse the schema