uk.ac.starlink.ttools.filter

Class ReplaceValueTable

java.lang.Object

uk.ac.starlink.table.WrapperStarTable

uk.ac.starlink.ttools.filter.ReplaceValueTable

All Implemented Interfaces:

Closeable, AutoCloseable, StarTable

public class ReplaceValueTable
extends WrapperStarTable

Wrapper table which makes replacements of named values with other named values in some of its columns.

Since:

20 Sep 2005

Author:

Mark Taylor

Field Summary

Fields inherited from class uk.ac.starlink.table.WrapperStarTable

baseTable

Constructor Summary

Constructors

Constructor and Description
ReplaceValueTable(StarTable baseTable, boolean[] colFlags, String oldStr, String newStr) Constructs a new ReplaceValueTable with the same replacement taking place in zero or more of the base table's columns, as described by an array of flags.
ReplaceValueTable(StarTable baseTable, int[] icols, String[] oldStrs, String[] newStrs) Constructs a new ReplaceValueTable from parallel arrays describing the columns to change and the old and new values.

Method Summary

Modifier and Type	Method and Description
Object	getCell(long irow, int icol) Returns the contents of a given table cell.
ColumnInfo	getColumnInfo(int icol) Returns the object describing the data in a given column.
Object[]	getRow(long irow) Returns the contents of a given table row.
RowAccess	getRowAccess() Returns an object which can provide random access to this table's data, if random access is implemented.
RowSequence	getRowSequence() Returns an object which can iterate over all the rows in the table sequentially.
RowSplittable	getRowSplittable() Returns an object which can iterate over all the rows in the table, but which may also be requested to split recursively for potentially parallel processing.

Methods inherited from class uk.ac.starlink.table.WrapperStarTable

checkedLongToInt, close, getBaseTable, getColumnAuxDataInfos, getColumnCount, getName, getParameterByName, getParameters, getRowCount, getURL, isRandom, setName, setParameter, setURL, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplaceValueTable

public ReplaceValueTable(StarTable baseTable,
                         boolean[] colFlags,
                         String oldStr,
                         String newStr)
                  throws IOException

Constructs a new ReplaceValueTable with the same replacement taking place in zero or more of the base table's columns, as described by an array of flags.

Parameters:

baseTable - base table

colFlags - array of flags for each column of the table, true only for those columns which should be modified

oldStr - value to be replaced

newStr - replacement value

Throws:

IOException

ReplaceValueTable

public ReplaceValueTable(StarTable baseTable,
                         int[] icols,
                         String[] oldStrs,
                         String[] newStrs)
                  throws IOException

Constructs a new ReplaceValueTable from parallel arrays describing the columns to change and the old and new values. The additional arguments are a set of parallel arrays, with an element for each of the replacements which will happen. Each of the arrays icols, oldStrs and newStrs must have the same number of elements. Indices in icols ought not to be repeated.

Parameters:

baseTable - base table

icols - array of column indices in which replacements will occur

oldStrs - array of strings to be replaced, one for each of the columns in icols

newStrs - array of strings to furnish replacement values, one for each of the columns in icols

Throws:

IOException

Method Detail

getColumnInfo

public ColumnInfo getColumnInfo(int icol)

Description copied from interface: StarTable

Returns the object describing the data in a given column.

Specified by:

getColumnInfo in interface StarTable

Overrides:

getColumnInfo in class WrapperStarTable

Parameters:

icol - the column for which header information is required

Returns:

a ValueInfo object for column icol

getCell

public Object getCell(long irow,
                      int icol)
               throws IOException

Description copied from interface: StarTable

Returns the contents of a given table cell. The class of the returned object should be the same as, or a subclass of, the class returned by getColumnInfo(icol).getContentClass().

This method is safe for concurrent use from multiple threads, but in general it is recommended to use a RowAccess instead.

Specified by:

getCell in interface StarTable

Overrides:

getCell in class WrapperStarTable

Parameters:

irow - the index of the cell's row

icol - the index of the cell's column

Returns:

the contents of this cell

Throws:

IOException - if there is an error reading the data

getRow

public Object[] getRow(long irow)
                throws IOException

Description copied from interface: StarTable

Returns the contents of a given table row. The returned value is equivalent to an array formed of all the objects returned by getCell(irow,icol) for all the columns icol in sequence.

This method is safe for concurrent use from multiple threads, but in general it is recommended to use a RowAccess instead.

Specified by:

getRow in interface StarTable

Overrides:

getRow in class WrapperStarTable

Parameters:

irow - the index of the row to retrieve

Returns:

an array of the objects in each cell in row irow

Throws:

IOException - if there is an error reading the data

getRowSequence

public RowSequence getRowSequence()
                           throws IOException

Description copied from interface: StarTable

Returns an object which can iterate over all the rows in the table sequentially. Each such returned object is safe for use within a single thread, but not in general from multiple threads concurrently.

Specified by:

getRowSequence in interface StarTable

Overrides:

getRowSequence in class WrapperStarTable

Returns:

new RowSequence

Throws:

IOException - if there is an error providing access

getRowAccess

public RowAccess getRowAccess()
                       throws IOException

Description copied from interface: StarTable

Returns an object which can provide random access to this table's data, if random access is implemented. Each such returned object is safe for use within a single thread, but not in general from multiple threads concurrently.

Specified by:

getRowAccess in interface StarTable

Overrides:

getRowAccess in class WrapperStarTable

Returns:

new RowAccess

Throws:

IOException - if there is an error setting up access

getRowSplittable

public RowSplittable getRowSplittable()
                               throws IOException

Description copied from interface: StarTable

Returns an object which can iterate over all the rows in the table, but which may also be requested to split recursively for potentially parallel processing.

The return value must be non-null, and may provide splitting arrangements specially appropriate for the implementation. If this table 'wraps' an upstream table, it is usually best to base the implementation on calls to the the upstream getRowSplittable method, so that upstream policy about how to divide up the table is respected. However, implementations without special requirements may return Tables.getDefaultRowSplittable(this).

Specified by:

getRowSplittable in interface StarTable

Overrides:

getRowSplittable in class WrapperStarTable

Returns:

new RowSplittable

Throws:

IOException

See Also:

RowRunner