com.vladsch.flexmark.util.format

Class MarkdownTable

java.lang.Object

com.vladsch.flexmark.util.format.MarkdownTable

public class MarkdownTable
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MarkdownTable.IndexSpanOffset

Field Summary

Fields

Modifier and Type	Field and Description
static NumericSuffixPredicate	ALL_SUFFIXES_NO_SORT
static NumericSuffixPredicate	ALL_SUFFIXES_SORT
TableSection	body
TableSection	caption
static com.vladsch.flexmark.util.misc.CharPredicate	COLON_TRIM_CHARS
TableSection	header
static NumericSuffixPredicate	NO_SUFFIXES
TableFormatOptions	options
TableSection	separator

Constructor Summary

Constructors

Constructor and Description
MarkdownTable(@NotNull CharSequence tableChars, @Nullable com.vladsch.flexmark.util.data.DataHolder options)
MarkdownTable(@NotNull CharSequence tableChars, @Nullable TableFormatOptions options)

Method Summary

Modifier and Type	Method and Description
void	addCell(@NotNull TableCell cell)
boolean	addTrackedOffset(int offset) Deprecated. Use addTrackedOffset(TrackedOffset) To create: TrackedOffset.track(offset)
boolean	addTrackedOffset(int offset, boolean afterSpace) Deprecated. Use addTrackedOffset(TrackedOffset) To create: TrackedOffset.track(offset, afterSpace)
boolean	addTrackedOffset(int offset, boolean afterSpace, boolean afterDelete) Deprecated. Use addTrackedOffset(TrackedOffset) To create: TrackedOffset.track(offset, afterSpace, afterDelete)
boolean	addTrackedOffset(int offset, Character c, boolean afterDelete) Deprecated. Use addTrackedOffset(TrackedOffset) To create: TrackedOffset.track(offset, c, afterDelete)
boolean	addTrackedOffset(@NotNull TrackedOffset trackedOffset)
static void	appendFormattedCaption(com.vladsch.flexmark.util.sequence.LineAppendable out, com.vladsch.flexmark.util.sequence.BasedSequence caption, TableFormatOptions options)
void	appendTable(com.vladsch.flexmark.util.sequence.LineAppendable out)
void	deleteColumns(int column, int count)
void	deleteRows(int rowIndex, int count)
void	fillMissingColumns()
void	fillMissingColumns(Integer minColumn)
void	finalizeTable()
void	forAllBodyRows(int startIndex, int count, TableRowManipulator manipulator)
void	forAllBodyRows(int startIndex, TableRowManipulator manipulator)
void	forAllBodyRows(TableRowManipulator manipulator)
void	forAllContentRows(int startIndex, int count, TableRowManipulator manipulator)
void	forAllContentRows(int startIndex, TableRowManipulator manipulator)
void	forAllContentRows(TableRowManipulator manipulator)
void	forAllHeaderRows(int startIndex, int count, TableRowManipulator manipulator)
void	forAllHeaderRows(int startIndex, TableRowManipulator manipulator)
void	forAllHeaderRows(TableRowManipulator manipulator)
void	forAllRows(int startIndex, int count, TableRowManipulator manipulator)
void	forAllRows(int startIndex, TableRowManipulator manipulator)
void	forAllRows(TableRowManipulator manipulator)
void	forAllSectionRows(int startIndex, int count, TableRowManipulator manipulator)
void	forAllSectionRows(int startIndex, TableRowManipulator manipulator)
void	forAllSectionRows(TableRowManipulator manipulator)
static String	formattedCaption(com.vladsch.flexmark.util.sequence.BasedSequence caption, TableFormatOptions options)
List<TableRow>	getAllContentRows()
int	getAllContentRowsCount()
List<TableRow>	getAllRows()
int	getAllRowsCount()
TableSection	getAllRowsSection(int index)
List<TableRow>	getAllSectionRows()
int	getAllSectionsRowsCount()
int	getBodyRowCount()
com.vladsch.flexmark.util.sequence.BasedSequence	getCaption()
TableCell	getCaptionCell()
int	getCaptionRowCount()
TableCellOffsetInfo	getCellOffsetInfo(int offset)
CharSequence	getFormatTableIndentPrefix()
boolean	getHaveCaption()
boolean	getHeader()
int	getHeadingRowCount()
int	getMaxBodyColumns()
int	getMaxColumns()
int	getMaxColumnsWithoutColumns(boolean withSeparator, int... skipColumns)
int	getMaxColumnsWithoutRows(boolean withSeparator, int... skipRows)
int	getMaxHeadingColumns()
int	getMaxSeparatorColumns()
int	getMinColumns()
int	getMinColumnsWithoutColumns(boolean withSeparator, int... skipColumns)
int	getMinColumnsWithoutRows(boolean withSeparator, int... skipRows)
int	getSeparatorRowCount()
CharSequence	getTableChars()
int	getTableStartOffset()
@Nullable TrackedOffset	getTrackedOffset(int offset)
int	getTrackedOffsetIndex(int offset)
@NotNull List<TrackedOffset>	getTrackedOffsets()
void	insertColumns(int column, int count)
void	insertRows(int rowIndex, int count)
boolean	isAllRowsEmptyAt(int rowIndex) Test a row for having all empty columns
boolean	isAllRowsSeparator(int index)
boolean	isContentRowsEmptyAt(int rowIndex) Test a row for having all empty columns
boolean	isEmptyColumn(int column) Test all rows for having given column empty.
boolean	isSeparator()
void	moveColumn(int fromColumn, int toColumn)
void	nextRow()
void	normalize()
void	setBody()
void	setCaption(CharSequence caption)
void	setCaptionCell(TableCell captionCell)
void	setCaptionWithMarkers(com.vladsch.flexmark.util.ast.Node tableCellNode, CharSequence captionOpen, CharSequence caption, CharSequence captionClose)
void	setFormatTableIndentPrefix(CharSequence formatTableIndentPrefix)
void	setHeader()
void	setHeader(boolean header)
void	setSeparator()
void	setSeparator(boolean separator)
MarkdownTable	sorted(ColumnSort[] columnSorts, int textCollectionFlags, @Nullable NumericSuffixPredicate numericSuffixTester) Sort table
String	toString()
MarkdownTable	transposed(int columnHeaders) Transpose table

Methods inherited from class java.lang.Object

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

Field Detail

header

public final TableSection header

separator

public final TableSection separator

body

public final TableSection body

caption

public final TableSection caption

options

public TableFormatOptions options

COLON_TRIM_CHARS

public static final com.vladsch.flexmark.util.misc.CharPredicate COLON_TRIM_CHARS

NO_SUFFIXES

public static final NumericSuffixPredicate NO_SUFFIXES

ALL_SUFFIXES_SORT

public static final NumericSuffixPredicate ALL_SUFFIXES_SORT

ALL_SUFFIXES_NO_SORT

public static final NumericSuffixPredicate ALL_SUFFIXES_NO_SORT

Constructor Detail

MarkdownTable

public MarkdownTable(@NotNull
                     @NotNull CharSequence tableChars,
                     @Nullable
                     @Nullable com.vladsch.flexmark.util.data.DataHolder options)

MarkdownTable

public MarkdownTable(@NotNull
                     @NotNull CharSequence tableChars,
                     @Nullable
                     @Nullable TableFormatOptions options)

Method Detail

getTableChars

public CharSequence getTableChars()

getCaptionCell

public TableCell getCaptionCell()

getFormatTableIndentPrefix

public CharSequence getFormatTableIndentPrefix()

setFormatTableIndentPrefix

public void setFormatTableIndentPrefix(CharSequence formatTableIndentPrefix)

setCaptionCell

public void setCaptionCell(TableCell captionCell)

getCaption

public com.vladsch.flexmark.util.sequence.BasedSequence getCaption()

setCaption

public void setCaption(CharSequence caption)

setCaptionWithMarkers

public void setCaptionWithMarkers(com.vladsch.flexmark.util.ast.Node tableCellNode,
                                  CharSequence captionOpen,
                                  CharSequence caption,
                                  CharSequence captionClose)

getHeadingRowCount

public int getHeadingRowCount()

getSeparatorRowCount

public int getSeparatorRowCount()

getBodyRowCount

public int getBodyRowCount()

getCaptionRowCount

public int getCaptionRowCount()

getMaxHeadingColumns

public int getMaxHeadingColumns()

getMaxSeparatorColumns

public int getMaxSeparatorColumns()

getMaxBodyColumns

public int getMaxBodyColumns()

getHaveCaption

public boolean getHaveCaption()

getMinColumns

public int getMinColumns()

getMaxColumns

public int getMaxColumns()

getMinColumnsWithoutColumns

public int getMinColumnsWithoutColumns(boolean withSeparator,
                                       int... skipColumns)

getMaxColumnsWithoutColumns

public int getMaxColumnsWithoutColumns(boolean withSeparator,
                                       int... skipColumns)

getMinColumnsWithoutRows

public int getMinColumnsWithoutRows(boolean withSeparator,
                                    int... skipRows)

getMaxColumnsWithoutRows

public int getMaxColumnsWithoutRows(boolean withSeparator,
                                    int... skipRows)

getTrackedOffsets

@NotNull
public @NotNull List<TrackedOffset> getTrackedOffsets()

getTrackedOffset

@Nullable
public @Nullable TrackedOffset getTrackedOffset(int offset)

getTrackedOffsetIndex

public int getTrackedOffsetIndex(int offset)

getTableStartOffset

public int getTableStartOffset()

getCellOffsetInfo

public TableCellOffsetInfo getCellOffsetInfo(int offset)

addTrackedOffset

@Deprecated
public boolean addTrackedOffset(int offset)

Deprecated. Use addTrackedOffset(TrackedOffset) To create: TrackedOffset.track(offset)

addTrackedOffset

@Deprecated
public boolean addTrackedOffset(int offset,
                                            boolean afterSpace)

Deprecated. Use addTrackedOffset(TrackedOffset) To create: TrackedOffset.track(offset, afterSpace)

addTrackedOffset

@Deprecated
public boolean addTrackedOffset(int offset,
                                            boolean afterSpace,
                                            boolean afterDelete)

Deprecated. Use addTrackedOffset(TrackedOffset) To create: TrackedOffset.track(offset, afterSpace, afterDelete)

addTrackedOffset

@Deprecated
public boolean addTrackedOffset(int offset,
                                            Character c,
                                            boolean afterDelete)

Deprecated. Use addTrackedOffset(TrackedOffset) To create: TrackedOffset.track(offset, c, afterDelete)

addTrackedOffset

public boolean addTrackedOffset(@NotNull
                                @NotNull TrackedOffset trackedOffset)

getAllRows

public List<TableRow> getAllRows()

getAllContentRows

public List<TableRow> getAllContentRows()

getAllSectionRows

public List<TableRow> getAllSectionRows()

isAllRowsSeparator

public boolean isAllRowsSeparator(int index)

getAllRowsSection

public TableSection getAllRowsSection(int index)

getAllRowsCount

public int getAllRowsCount()

getAllContentRowsCount

public int getAllContentRowsCount()

getAllSectionsRowsCount

public int getAllSectionsRowsCount()

forAllRows

public void forAllRows(TableRowManipulator manipulator)

forAllRows

public void forAllRows(int startIndex,
                       TableRowManipulator manipulator)

forAllRows

public void forAllRows(int startIndex,
                       int count,
                       TableRowManipulator manipulator)

forAllContentRows

public void forAllContentRows(TableRowManipulator manipulator)

forAllContentRows

public void forAllContentRows(int startIndex,
                              TableRowManipulator manipulator)

forAllContentRows

public void forAllContentRows(int startIndex,
                              int count,
                              TableRowManipulator manipulator)

forAllSectionRows

public void forAllSectionRows(TableRowManipulator manipulator)

forAllSectionRows

public void forAllSectionRows(int startIndex,
                              TableRowManipulator manipulator)

forAllSectionRows

public void forAllSectionRows(int startIndex,
                              int count,
                              TableRowManipulator manipulator)

forAllHeaderRows

public void forAllHeaderRows(TableRowManipulator manipulator)

forAllHeaderRows

public void forAllHeaderRows(int startIndex,
                             TableRowManipulator manipulator)

forAllHeaderRows

public void forAllHeaderRows(int startIndex,
                             int count,
                             TableRowManipulator manipulator)

forAllBodyRows

public void forAllBodyRows(TableRowManipulator manipulator)

forAllBodyRows

public void forAllBodyRows(int startIndex,
                           TableRowManipulator manipulator)

forAllBodyRows

public void forAllBodyRows(int startIndex,
                           int count,
                           TableRowManipulator manipulator)

deleteRows

public void deleteRows(int rowIndex,
                       int count)

insertRows

public void insertRows(int rowIndex,
                       int count)

insertColumns

public void insertColumns(int column,
                          int count)

deleteColumns

public void deleteColumns(int column,
                          int count)

moveColumn

public void moveColumn(int fromColumn,
                       int toColumn)

isEmptyColumn

public boolean isEmptyColumn(int column)

Test all rows for having given column empty. All columns after row's max column are empty

Parameters:

column - index in allRows list

Returns:

true if column is empty for all rows, separator row excluded

isAllRowsEmptyAt

public boolean isAllRowsEmptyAt(int rowIndex)

Test a row for having all empty columns

Parameters:

rowIndex - index in allRows list

Returns:

true if row is empty or is a separator row

isContentRowsEmptyAt

public boolean isContentRowsEmptyAt(int rowIndex)

Test a row for having all empty columns

Parameters:

rowIndex - index in allRows list

Returns:

true if row is empty or is a separator row

getHeader

public boolean getHeader()

setHeader

public void setHeader(boolean header)

isSeparator

public boolean isSeparator()

setSeparator

public void setSeparator(boolean separator)

setHeader

public void setHeader()

setSeparator

public void setSeparator()

setBody

public void setBody()

nextRow

public void nextRow()

addCell

public void addCell(@NotNull
                    @NotNull TableCell cell)

Parameters:

cell - cell to add

normalize

public void normalize()

finalizeTable

public void finalizeTable()

fillMissingColumns

public void fillMissingColumns()

fillMissingColumns

public void fillMissingColumns(Integer minColumn)

transposed

public MarkdownTable transposed(int columnHeaders)

Transpose table

Parameters:

columnHeaders - number of first columns to use as header rows, 0..maxColumns

Returns:

transposed table

sorted

public MarkdownTable sorted(ColumnSort[] columnSorts,
                            int textCollectionFlags,
                            @Nullable
                            @Nullable NumericSuffixPredicate numericSuffixTester)

Sort table

Parameters:

columnSorts - column sort information

textCollectionFlags - collection flags to use for collecting cell text

numericSuffixTester - predicate to test non-numeric suffix of numeric column content, return true if suffix is acceptable, null will result in all suffixes being accepted

Returns:

sorted table

appendTable

public void appendTable(com.vladsch.flexmark.util.sequence.LineAppendable out)

appendFormattedCaption

public static void appendFormattedCaption(com.vladsch.flexmark.util.sequence.LineAppendable out,
                                          com.vladsch.flexmark.util.sequence.BasedSequence caption,
                                          TableFormatOptions options)

formattedCaption

public static String formattedCaption(com.vladsch.flexmark.util.sequence.BasedSequence caption,
                                      TableFormatOptions options)

toString

public String toString()

Overrides:

toString in class Object