|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LabelParser
Method Summary | |
---|---|
void |
addIncludePath(java.net.URL includePath)
Adds an URL where references will be searched for when found in a label. |
void |
addValidator(LabelValidator validator)
Adds a LabelValidator that will perform some extravalidation. |
java.lang.String |
getODLVersion()
Returns the version of ODL that this parser is compliant with. |
java.lang.String |
getPDSVersion()
Returns the version of the PDS specification that this parser is compliant with. |
java.util.Properties |
getProperties()
Retrieves parser properties. |
Label |
parse(java.net.URL file)
Parses the given file |
Label |
parse(java.net.URL file,
Dictionary dictionary)
Parses the given file and validates against the dictionary. |
Label |
parse(java.net.URL file,
Dictionary dictionary,
boolean dataObjectValidation)
Parses the given file, validates against dictionary, and may perform dataObjectValidation |
Label |
parsePartial(java.lang.String context,
java.net.URL file)
Parses the given partial label. |
Label |
parsePartial(java.net.URL file)
Parses the given partial label. |
Label |
parsePartial(java.net.URL file,
Dictionary dictionary)
Parses the given partial label and validates against the dictionary. |
Label |
parsePartial(java.net.URL file,
Dictionary dictionary,
boolean dataObjectValidation)
Parses the given partial label, validates against dictionary, and may perform dataObjectValidation |
void |
setProperties(java.util.Properties properties)
Passes properties to the parser. |
Method Detail |
---|
Label parse(java.net.URL file) throws ParseException, java.io.IOException
file
- File to
Label
representation of the file
ParseException
- - If any syntatic errors are encountered.
All errors will be written to the Logger.
java.io.IOException
Label parse(java.net.URL file, Dictionary dictionary) throws ParseException, java.io.IOException
file
- dictionary
-
Label
representation of the file
ParseException
java.io.IOException
Label parse(java.net.URL file, Dictionary dictionary, boolean dataObjectValidation) throws ParseException, java.io.IOException
file
- dictionary
- dataObjectValidation
-
Label
representation of the file
ParseException
java.io.IOException
Label parsePartial(java.net.URL file) throws ParseException, java.io.IOException
file
-
Label
representation of the file
ParseException
java.io.IOException
Label parsePartial(java.lang.String context, java.net.URL file) throws ParseException, java.io.IOException
context
- file
-
Label
representation of the file
ParseException
java.io.IOException
Label parsePartial(java.net.URL file, Dictionary dictionary) throws ParseException, java.io.IOException
file
- dictionary
-
Label
representation of the file
ParseException
java.io.IOException
Label parsePartial(java.net.URL file, Dictionary dictionary, boolean dataObjectValidation) throws ParseException, java.io.IOException
file
- dictionary
- dataObjectValidation
-
Label
representation of the file
ParseException
java.io.IOException
void setProperties(java.util.Properties properties)
properties
- Set of properties.java.util.Properties getProperties()
java.lang.String getPDSVersion()
java.lang.String getODLVersion()
void addIncludePath(java.net.URL includePath)
includePath
- points to a directory that will be searched.void addValidator(LabelValidator validator)
LabelValidator
that will perform some extravalidation.
validator
- which will be run as a step in the validation pipeline
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |