com.phoenix_int.aserver.util.scriptwrapper.api
Class PHXRowFieldRange

java.lang.Object
  com.phoenix_int.aserver.util.scriptwrapper.api.PHXRowFieldRange

All Implemented Interfaces:

IPHXRange

public class PHXRowFieldRange

extends java.lang.Object

implements IPHXRange

Field Summary

static java.lang.String	NAME_SEPARATOR
static java.lang.String	RANGE_SEPARATOR

Constructor Summary

PHXRowFieldRange()

PHXRowFieldRange(java.lang.String str)

PHXRowFieldRange(java.lang.String pageName, int row)

PHXRowFieldRange(java.lang.String pageName, int row, int field)

PHXRowFieldRange(java.lang.String start, java.lang.String end)

PHXRowFieldRange(java.lang.String pageName, java.lang.String parent, int startRow)

PHXRowFieldRange(java.lang.String pageName, java.lang.String startRow, java.lang.String endRow)

PHXRowFieldRange(java.lang.String pageName, java.lang.String parent, java.lang.String startMark, int startOccurrence)

PHXRowFieldRange(java.lang.String pageName, java.lang.String parent, java.lang.String start, java.lang.String end)

PHXRowFieldRange(java.lang.String pageName, java.lang.String startRow, java.lang.String endRow, java.lang.String startCol, java.lang.String endCol)

Method Summary

int	absoluteEndRow(IPHXLineStore lines, java.util.Vector bookmarks, java.util.Vector sections)
int	absoluteStartRow(IPHXLineStore lines, java.util.Vector bookmarks, java.util.Vector sections) Returns the actual starting row number
void	assertEquals(IPHXRange other) Test comparison function.
void	clearEndingMark()
void	clearStartingMark()
void	fromString(java.lang.String str)
java.lang.String	getDelimiters()
java.lang.String	getEnd()
int	getEndCol()
java.lang.String	getEndMark()
int	getEndOccurrence()
int	getEndOffset()
java.lang.String	getEndParent()
int	getEndRow()
int	getNumDimensions()
int	getNumDimensions(java.lang.String fformat)
java.lang.String	getPageName()
java.lang.String	getParent()
java.lang.String	getRowColString()
java.lang.String	getStart()
java.lang.String	getStart(boolean addEscapes)
int	getStartCol()
java.lang.String	getStartMark()
int	getStartOccurrence()
int	getStartOffset()
int	getStartRow()
boolean	isArray()
boolean	isColArray()
boolean	isHorizontallyResizable()
boolean	isRowArray()
void	setDelimiters(java.lang.String delim)
void	setEndingCol(int col)
void	setEndingMark(java.lang.String mark, int occurrence, int offset)
void	setEndingRow(int row)
void	setEndParent(java.lang.String parent)
void	setPageName(java.lang.String pageName)
void	setParent(java.lang.String parent)
void	setStartingCol(int col)
void	setStartingMark(java.lang.String mark, int occurrence, int offset)
void	setStartingRow(int row)
static java.util.Vector<java.lang.String>	split(java.lang.String rangeStrings) Splits a multi-range string into individual range strings.
java.lang.String	toString()
java.lang.String	toString(boolean showPageName)

Methods inherited from class java.lang.Object

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

Field Detail

RANGE_SEPARATOR

public static final java.lang.String RANGE_SEPARATOR

See Also:

Constant Field Values

NAME_SEPARATOR

public static final java.lang.String NAME_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

PHXRowFieldRange

public PHXRowFieldRange()

PHXRowFieldRange

public PHXRowFieldRange(java.lang.String str)

PHXRowFieldRange

public PHXRowFieldRange(java.lang.String start,
                        java.lang.String end)

PHXRowFieldRange

public PHXRowFieldRange(java.lang.String pageName,
                        java.lang.String parent,
                        java.lang.String start,
                        java.lang.String end)

PHXRowFieldRange

public PHXRowFieldRange(java.lang.String pageName,
                        int row)

PHXRowFieldRange

public PHXRowFieldRange(java.lang.String pageName,
                        int row,
                        int field)

PHXRowFieldRange

public PHXRowFieldRange(java.lang.String pageName,
                        java.lang.String parent,
                        int startRow)

PHXRowFieldRange

public PHXRowFieldRange(java.lang.String pageName,
                        java.lang.String parent,
                        java.lang.String startMark,
                        int startOccurrence)

PHXRowFieldRange

public PHXRowFieldRange(java.lang.String pageName,
                        java.lang.String startRow,
                        java.lang.String endRow)

PHXRowFieldRange

public PHXRowFieldRange(java.lang.String pageName,
                        java.lang.String startRow,
                        java.lang.String endRow,
                        java.lang.String startCol,
                        java.lang.String endCol)

Method Detail

getParent

public java.lang.String getParent()

getEndParent

public java.lang.String getEndParent()

setParent

public void setParent(java.lang.String parent)

setEndParent

public void setEndParent(java.lang.String parent)

setDelimiters

public void setDelimiters(java.lang.String delim)

getDelimiters

public java.lang.String getDelimiters()

getPageName

public java.lang.String getPageName()

Specified by:

getPageName in interface IPHXRange

setPageName

public void setPageName(java.lang.String pageName)

setStartingRow

public void setStartingRow(int row)

setEndingRow

public void setEndingRow(int row)

setStartingCol

public void setStartingCol(int col)

setEndingCol

public void setEndingCol(int col)

setStartingMark

public void setStartingMark(java.lang.String mark,
                            int occurrence,
                            int offset)

clearStartingMark

public void clearStartingMark()

setEndingMark

public void setEndingMark(java.lang.String mark,
                          int occurrence,
                          int offset)

clearEndingMark

public void clearEndingMark()

getStartMark

public java.lang.String getStartMark()

getStartOccurrence

public int getStartOccurrence()

getStartOffset

public int getStartOffset()

getEndMark

public java.lang.String getEndMark()

getEndOccurrence

public int getEndOccurrence()

getEndOffset

public int getEndOffset()

getStartRow

public int getStartRow()

getEndRow

public int getEndRow()

getStartCol

public int getStartCol()

getEndCol

public int getEndCol()

getStart

public java.lang.String getStart()

getStart

public java.lang.String getStart(boolean addEscapes)

getEnd

public java.lang.String getEnd()

getNumDimensions

public int getNumDimensions(java.lang.String fformat)

getNumDimensions

public int getNumDimensions()

isArray

public boolean isArray()

isRowArray

public boolean isRowArray()

isColArray

public boolean isColArray()

isHorizontallyResizable

public boolean isHorizontallyResizable()

absoluteStartRow

public int absoluteStartRow(IPHXLineStore lines,
                            java.util.Vector bookmarks,
                            java.util.Vector sections)
                     throws PHXBookmarkNotFoundException,
                            PHXSectionNotFoundException

Returns the actual starting row number

Parameters:

lines - list of all lines to search

bookmarks - list of all bookmarks to consider

sections - list of all sections to consider

Returns:

actual start row

Throws:

PHXBookmarkNotFoundException

PHXSectionNotFoundException

absoluteEndRow

public int absoluteEndRow(IPHXLineStore lines,
                          java.util.Vector bookmarks,
                          java.util.Vector sections)
                   throws PHXBookmarkNotFoundException,
                          PHXSectionNotFoundException

Throws:

PHXBookmarkNotFoundException

PHXSectionNotFoundException

toString

public java.lang.String toString()

Specified by:

toString in interface IPHXRange

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(boolean showPageName)

Specified by:

toString in interface IPHXRange

getRowColString

public java.lang.String getRowColString()

fromString

public void fromString(java.lang.String str)

Specified by:

fromString in interface IPHXRange

split

public static java.util.Vector<java.lang.String> split(java.lang.String rangeStrings)

Splits a multi-range string into individual range strings. Example string: PageName|r21c24:39[delims],PageName|r1c1,PageName|Bookmark|r1c1,...

Parameters:

rangeStrings - the multi-range string

Returns:

a Vector of range strings

assertEquals

public void assertEquals(IPHXRange other)
                  throws java.lang.Exception

Test comparison function. If the two objects are not equal, an exception is thrown

Specified by:

assertEquals in interface IPHXRange

Parameters:

other - the data model to compare this to

Throws:

java.lang.Exception - thrown if the data models do not match