org.dmd.util.parsing

Class DmcUncheckedOIFParser

java.lang.Object

org.dmd.util.parsing.DmcUncheckedOIFParser

public class DmcUncheckedOIFParser
extends Object

This class parses files that conform to Object Instance Format (OIF).

Object Instance Format is a text-based format that allows for the capture of just about any type of data. The kinds of objects that can be represented depend on schemas that are defined as part of a Dark Matter Schema (DMS).

At this level of parsing, no real error checking is performed - that will be taken care of by the object handler that understands the specifics of the schema that should be followed by the objects in the file.

See Also:

parseFile(java.lang.String)

Constructor Summary

Constructors

Constructor and Description
DmcUncheckedOIFParser(DmcUncheckedOIFHandlerIF objHandler) Creates a new Object Instance Format parser.

Method Summary

Modifier and Type	Method and Description
void	addPreserveNewlinesAttribute(String an)
void	allowedErrors(int i) Allows you to set the number of errors that you're willing to ignore during the parsing.
void	dropLineContinuations() The OIF format uses the idea of continuing an attribute value across multiple lines by starting subsequent lines with a space.
void	parseFile(String fileName) Parses the specified file and sends the objects to the object handler specified in the constructor.
void	parseFile(String fileName, boolean isResource) Parses the specified file and sends the objects to the object handler specified in the constructor.

Methods inherited from class java.lang.Object

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

Constructor Detail

DmcUncheckedOIFParser

public DmcUncheckedOIFParser(DmcUncheckedOIFHandlerIF objHandler)

Creates a new Object Instance Format parser. As new BasicObjects are created, they will be passed to the object handler for processing.

Method Detail

addPreserveNewlinesAttribute

public void addPreserveNewlinesAttribute(String an)

dropLineContinuations

public void dropLineContinuations()

The OIF format uses the idea of continuing an attribute value across multiple lines by starting subsequent lines with a space. By setting this option, the leading space will be dropped from attribute value input.

allowedErrors

public void allowedErrors(int i)

Allows you to set the number of errors that you're willing to ignore during the parsing. The default is to quit parsing whenever an error is encountered. If you don't care how many errors you find, set the allowedErrors to -1.

The parsing will always stop if we encounter a FATAL error (as reflected in the ResultSet).

parseFile

public void parseFile(String fileName)
               throws ResultException,
                      DmcValueException,
                      DmcRuleExceptionSet,
                      DmcNameClashException

Parses the specified file and sends the objects to the object handler specified in the constructor.

Parameters:

fileName - The file to be parsed.

Throws:

ResultException, - DmcValueException

DmcRuleExceptionSet

DmcNameClashException

ResultException

DmcValueException

parseFile

public void parseFile(String fileName,
                      boolean isResource)
               throws ResultException,
                      DmcValueException,
                      DmcRuleExceptionSet,
                      DmcNameClashException

Parses the specified file and sends the objects to the object handler specified in the constructor.

Parameters:

fileName - The file to be parsed.

isResource - A flag to indicate if the file name refers to a resource e.g. in a JAR. If so, we have to approach the opening of the file differently.

Throws:

ResultException, - DmcValueException

DmcRuleExceptionSet

DmcNameClashException

ResultException

DmcValueException