Package nzilbb.labbcat.server.search

Class CsvResults

    • Constructor Detail

      • CsvResults

        public CsvResults​(File csvFile,
                  nzilbb.sql.ConnectionFactory db)
           throws IOException
        Constructor from CSV File.
        Parameters:
        csvFile - The results file to parse.
        Throws:
        IOException

    • Method Detail

      • getCsvFile

        public File getCsvFile()
        Getter for csvFile: The results file to parse.
        Returns:
        The results file to parse.

      • getCsvColumns

        public List<String> getCsvColumns()
        Getter for csvColumns: Columns available in csv source file, if any.
        Returns:
        Columns available in csv source file, if any.

      • getCsvFieldDelimiter

        public char getCsvFieldDelimiter()
        Getter for csvFieldDelimiter: Field delimiter to use when reading the file.
        Returns:
        Field delimiter to use when reading the file.

      • setCsvFieldDelimiter

        public CsvResults setCsvFieldDelimiter​(char newCsvFieldDelimiter)
        Setter for csvFieldDelimiter: Field delimiter to use when reading the file.
        Parameters:
        newCsvFieldDelimiter - Field delimiter to use when reading the file.

      • getTargetColumn

        public String getTargetColumn()
        Getter for targetColumn: Name of the column that identifies each match (default "MatchId").
        Returns:
        Name of the column that identifies each match (default "MatchId").

      • setTargetColumn

        public CsvResults setTargetColumn​(String newTargetColumn)
        Setter for targetColumn: Name of the column that identifies each match (default "MatchId").
        Parameters:
        newTargetColumn - Name of the column that identifies each match (default "MatchId").

      • getName

        public String getName()
        SearchResults method: A descriptive name for the collection.
        Specified by:
        getName in interface SearchResults
        Returns:
        A descriptive name for the collection.

      • setName

        public CsvResults setName​(String newName)
        Setter for name: Name of result set.
        Parameters:
        newName - Name of result set.

      • getPageLength

        public int getPageLength()
        Getter for pageLength: The maximum number of results to return from next(), or 0 for no maximum.
        Specified by:
        getPageLength in interface SearchResults
        Returns:
        The maximum number of results to return from next(), or 0 for no maximum.

      • setPageLength

        public SearchResults setPageLength​(int newPageLength)
        Setter for pageLength: The maximum number of results to return from next(), or 0 for no maximum.
        Specified by:
        setPageLength in interface SearchResults
        Parameters:
        newPageLength - The maximum number of results to return from next(), or 0 for no maximum.

      • getLastMatchId

        public String getLastMatchId()
        Getter for lastMatchId: The ID of the last match the iterator returned from next()
        Specified by:
        getLastMatchId in interface SearchResults
        Returns:
        The ID of the last match the iterator returned from next()

      • getLastRecord

        public org.apache.commons.csv.CSVRecord getLastRecord()
        Getter for lastRecord: The last CSV record parsed, if any.
        Returns:
        The last CSV record parsed, if any.

      • getConnection

        public Connection getConnection()
                         throws SQLException
        Getter for connection: Database connection.
        Returns:
        Database connection.
        Throws:
        SQLException - If a new connection is required, but can't be created.

      • setConnection

        public CsvResults setConnection​(Connection newConnection)
        Setter for connection: Database connection.
        Parameters:
        newConnection - Database connection.

      • getDb

        public nzilbb.sql.ConnectionFactory getDb()
        Getter for db: Factory for generating connections to the database.
        Returns:
        Factory for generating connections to the database.

      • setDb

        public CsvResults setDb​(nzilbb.sql.ConnectionFactory newDb)
        Setter for db: Factory for generating connections to the database.
        Parameters:
        newDb - Factory for generating connections to the database.

      • reset

        public void reset()
        SearchResults method: Resets the iterator to the beginning of the list
        Specified by:
        reset in interface SearchResults

      • size

        public int size()
        SearchResults method: Returns the number of utterances in the collection.
        Specified by:
        size in interface SearchResults
        Returns:
        The number of utterances in the collection.

      • seek

        public boolean seek​(int n)
        Go to the nth item in the list, so it will be the next returned by next().
        Specified by:
        seek in interface SearchResults
        Parameters:
        n - The number of the item to seek to.
        Returns:
        true if the nth item exists, false otherwise.

      • hasNext

        public boolean hasNext()
        Iterator method: Returns true if the iteration has more elements.
        Specified by:
        hasNext in interface Iterator<String>
        Returns:
        true if the iteration has more elements.

      • next

        public String next()
        Iterator method: Returns the next result ID.
        Specified by:
        next in interface Iterator<String>
        Returns:
        The next result ID.

      • close

        public void close()
        Close all open resources (there are none).
        Specified by:
        close in interface AutoCloseable
        Specified by:
        close in interface Closeable