com.f1j.ss.datarange
Interface DataRange

public interface DataRange
extends Lockable

This interface defines the DataRange API. You can use this api to get the bounds of the DataRange, get the root Section's of the DataRange, or get and set the default DataSet for the DataRange.

Since:
12.0
See Also:
Section, DataSet

Method Summary
 Range getBounds()
          Returns the bounds of this DataRange.
 Section getColumnRootSection()
          Returns the root, outer-most, Section for the column area of a DataRange.
 DataSet getDefaultDataSet()
          Returns the default DataSet for this DataRange.
 DataSet getDefaultDataSet(boolean checkSheetAndBook)
          Returns the default DataSet for this DataRange.
 Section getRowRootSection()
          Returns the root, outer-most, Section for the row area of a DataRange.
 void setDefaultDataSet(DataSet dataSet)
          Sets the default DataSet for this DataRange.
 
Methods inherited from interface com.f1j.util.Lockable
getLock, releaseLock
 

Method Detail

getBounds

public Range getBounds()
Returns the bounds of this DataRange.
Returns:
The bounds of this DataRange.
Since:
12.0
See Also:
Range

getColumnRootSection

public Section getColumnRootSection()
Returns the root, outer-most, Section for the column area of a DataRange.
Returns:
the root Section of the column area.
Since:
12.0
See Also:
Section

getRowRootSection

public Section getRowRootSection()
Returns the root, outer-most, Section for the row area of a DataRange.
Returns:
the root Section of the row area.
Since:
12.0
See Also:
Section

getDefaultDataSet

public DataSet getDefaultDataSet()
Returns the default DataSet for this DataRange. If a default DataSet has not been explicitly set for the DataRange, then null is returned. If the range does not have a default, try checking the sheet and/or book.
Returns:
the default DataSet explicitly set on this DataRange.
Since:
12.0
See Also:
setDefaultDataSet(com.f1j.data.DataSet), DataSet

getDefaultDataSet

public DataSet getDefaultDataSet(boolean checkSheetAndBook)
Returns the default DataSet for this DataRange. If the checkSheetAndBook flag is true and a default DataSet has not been explicitly set for the DataRange, then the default for the sheet or the book will be returned. If the checkSheetAndBook flag is false and a default DataSet has not been explicitly set for the DataRange, then null is returned.
Returns:
the default DataSet to be used by this DataRange.
Since:
12.0
See Also:
setDefaultDataSet(com.f1j.data.DataSet), DataSet

setDefaultDataSet

public void setDefaultDataSet(DataSet dataSet)
                       throws InvalidArgumentException
Sets the default DataSet for this DataRange. Set the DataSet to null to remove a range level default.
Parameters:
dataSet - The DataSet that should be used as the default for this DataRange.
Throws:
InvalidArgumentException - if the specified DataSet does not exist in the book.
Since:
12.0
See Also:
getDefaultDataSet(), DataSet