Class RLSCSVsParser

java.lang.Object

fr.inria.rules.integraal.io.csv.RLSCSVsParser

All Implemented Interfaces:

Parser<Atom>, CloseableIterator<Atom>, Closeable, AutoCloseable

public class RLSCSVsParser
extends Object
implements Parser<Atom>, AutoCloseable

Parses an RLS CSV configuration file into a stream of atoms.

Author:

Florent Tornil

This class parses a list of CSV file into atoms.

Retrieves CSV files from a configuration file inspired from RLS syntax <a href="https://github.com/knowsys/rulewerk/wiki/Rule-syntax-grammar#source-declarations">...</a> Each line of the configuration file defines a CSV file to be parsed as well as the predicate it defines.

The CSVParser is used for each file. It is assumed that all the CSV file have the same separator, prefix and header size.

Constructor Summary

Constructors

Constructor	Description
RLSCSVsParser(File file, char separator, String prefix, int headerSize, boolean encode)	Creates a parser from an RLS configuration file and CSV options.
RLSCSVsParser(String filePath)	Creates a parser from an RLS configuration file path.
RLSCSVsParser(String filePath, boolean encode)	Creates a parser from an RLS configuration file path and encoding mode.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the iterator and releases its resources.
static List<String>	getRLSFileLines(String configRLSFile)	Reads every line from the supplied RLS configuration file.
boolean	hasNext()	Indicates whether another element can be read from the iterator.
Atom	next()	Returns the next element from the iterator.
ParserResult	parse()	Parses the whole configuration and returns the materialized parser result.

Methods inherited from class Object

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

Methods inherited from interface Parser

streamParsedObjects

Constructor Details

RLSCSVsParser

public RLSCSVsParser(String filePath)

Creates a parser from an RLS configuration file path.

Parameters:

filePath - to RLS configuration file to parseAll with default configuration

RLSCSVsParser

public RLSCSVsParser(String filePath,
 boolean encode)

Creates a parser from an RLS configuration file path and encoding mode.

Parameters:

filePath - to RLS configuration file to parseAll with default configuration

encode - a boolean true iff the CSV has to be encoded first

RLSCSVsParser

public RLSCSVsParser(File file,
 char separator,
 String prefix,
 int headerSize,
 boolean encode)

Creates a parser from an RLS configuration file and CSV options.

Parameters:

file - RLS configuration file to parseAll

separator - separator character of the CSV file

prefix - prefix of the predicate name

headerSize - size of the header of the CSV file

encode - a boolean true iff the CSV has to be encoded first

Method Details

hasNext

public boolean hasNext()

Description copied from interface: CloseableIterator

Indicates whether another element can be read from the iterator.

Specified by:

hasNext in interface CloseableIterator<Atom>

Specified by:

hasNext in interface Parser<Atom>

Returns:

true iff there is a next element

next

public Atom next()

Description copied from interface: CloseableIterator

Returns the next element from the iterator.

Specified by:

next in interface CloseableIterator<Atom>

Specified by:

next in interface Parser<Atom>

Returns:

the next element

close

public void close()

Description copied from interface: CloseableIterator

Closes the iterator and releases its resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface CloseableIterator<Atom>

parse

public ParserResult parse()

Parses the whole configuration and returns the materialized parser result.

Specified by:

parse in interface Parser<Atom>

Returns:

the parsed atoms wrapped in a parser result

getRLSFileLines

public static List<String> getRLSFileLines(String configRLSFile)
                                    throws FileNotFoundException

Reads every line from the supplied RLS configuration file.

Parameters:

configRLSFile - to parseAll

Returns:

the lines in the configRLSFile

Throws:

FileNotFoundException - exception