APIdia Launch Partner
Top Description Inners Fields Constructors Methods
io.github.spannm.jackcess.impl

public abstract Class TableMutator

extends DBMutator
Class Inheritance
Known Direct Subclasses
io.github.spannm.jackcess.impl.TableUpdater, io.github.spannm.jackcess.impl.TableCreator
Imports
io.github.spannm.jackcess.ColumnBuilder, .DataType, .IndexBuilder, java.util.ArrayList, .List, .Set

Common helper class used to maintain state during table mutation.

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static class
TableMutator.ColumnOffsets

Maintains additional state used during column writing.

pack-priv static class
TableMutator.ColumnState

Maintains additional state used during column creation.

pack-priv static class
TableMutator.IndexDataState

Maintains additional state used during index data creation.

Field Summary

Modifier and TypeField and Description
private TableMutator.ColumnOffsets

Constructor Summary

AccessConstructor and Description
protected

Method Summary

Modifier and TypeMethod and Description
pack-priv abstract short
public TableMutator.ColumnOffsets
public abstract TableMutator.ColumnState
public IndexImpl.ForeignKeyReference
public abstract TableMutator.IndexDataState
pack-priv abstract String
public abstract int
pack-priv abstract boolean

Returns:

true if the named column holds a complex type, false if it does not or if there is no such column
isComplexColumn
(String
name of the column
colName
)

Checks whether the named column holds a complex type.

public void
setColumnOffsets(int fixedOffset, int varOffset, int longVarOffset)

private void
protected void
protected void
protected void
validateIndex(Set<String> colNames, Set<String> idxNames, boolean[] foundPk, IndexBuilder index)

protected abstract String
Inherited from io.github.spannm.jackcess.impl.DBMutator:
calculateNameLengthgetCharsetgetDatabasegetDbSortOrdergetFormatgetPageChannelreservePageNumber

Field Detail

colOffsetsback to summary
private TableMutator.ColumnOffsets colOffsets

Constructor Detail

TableMutatorback to summary
protected TableMutator(DatabaseImpl database)

Method Detail

getColumnNumberback to summary
pack-priv abstract short getColumnNumber(String colName)
getColumnOffsetsback to summary
public TableMutator.ColumnOffsets getColumnOffsets()
getColumnStateback to summary
public abstract TableMutator.ColumnState getColumnState(ColumnBuilder col)
getForeignKeyback to summary
public IndexImpl.ForeignKeyReference getForeignKey(IndexBuilder idx)
getIndexDataStateback to summary
public abstract TableMutator.IndexDataState getIndexDataState(IndexBuilder idx)
getTableNameback to summary
pack-priv abstract String getTableName()
getTdefPageNumberback to summary
public abstract int getTdefPageNumber()
isComplexColumnback to summary
pack-priv abstract boolean isComplexColumn(String colName)

Checks whether the named column holds a complex type.

Parameters
colName:String

name of the column

Returns:boolean

true if the named column holds a complex type, false if it does not or if there is no such column

setColumnOffsetsback to summary
public void setColumnOffsets(int fixedOffset, int varOffset, int longVarOffset)
setColumnSortOrderback to summary
private void setColumnSortOrder(ColumnBuilder column)
validateAutoNumberColumnback to summary
protected void validateAutoNumberColumn(Set<DataType> autoTypes, ColumnBuilder column)
validateColumnback to summary
protected void validateColumn(Set<String> colNames, ColumnBuilder column)
validateIndexback to summary
protected void validateIndex(Set<String> colNames, Set<String> idxNames, boolean[] foundPk, IndexBuilder index)
withErrorContextback to summary
protected abstract String withErrorContext(String msg)
io.github.spannm.jackcess.impl back to summary

pack-priv final Class TableMutator.ColumnOffsets

extends Object
Class Inheritance

Maintains additional state used during column writing.

Field Summary

Modifier and TypeField and Description
private short
private short
private short

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public short
public short
public void
set(int newFixedOffset, int newVarOffset, int newLongVarOffset)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

fixedOffsetback to summary
private short fixedOffset
longVarOffsetback to summary
private short longVarOffset
varOffsetback to summary
private short varOffset

Constructor Detail

ColumnOffsetsback to summary
pack-priv ColumnOffsets()

Method Detail

getNextFixedOffsetback to summary
public short getNextFixedOffset(ColumnBuilder col)
getNextVariableOffsetback to summary
public short getNextVariableOffset(ColumnBuilder col)
setback to summary
public void set(int newFixedOffset, int newVarOffset, int newLongVarOffset)
io.github.spannm.jackcess.impl back to summary

pack-priv final Class TableMutator.ColumnState

extends Object
Class Inheritance

Maintains additional state used during column creation.

Field Summary

Modifier and TypeField and Description
private byte
private byte
private int

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public byte
public byte
public int
public void
setUmapFreeRowNumber(byte newUmapFreeRowNumber)

public void
setUmapOwnedRowNumber(byte newUmapOwnedRowNumber)

public void
setUmapPageNumber(int newUmapPageNumber)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

umapFreeRowNumberback to summary
private byte umapFreeRowNumber
umapOwnedRowNumberback to summary
private byte umapOwnedRowNumber
umapPageNumberback to summary
private int umapPageNumber

Constructor Detail

ColumnStateback to summary
pack-priv ColumnState()

Method Detail

getUmapFreeRowNumberback to summary
public byte getUmapFreeRowNumber()
getUmapOwnedRowNumberback to summary
public byte getUmapOwnedRowNumber()
getUmapPageNumberback to summary
public int getUmapPageNumber()
setUmapFreeRowNumberback to summary
public void setUmapFreeRowNumber(byte newUmapFreeRowNumber)
setUmapOwnedRowNumberback to summary
public void setUmapOwnedRowNumber(byte newUmapOwnedRowNumber)
setUmapPageNumberback to summary
public void setUmapPageNumber(int newUmapPageNumber)
io.github.spannm.jackcess.impl back to summary

pack-priv final Class TableMutator.IndexDataState

extends Object
Class Inheritance

Maintains additional state used during index data creation.

Field Summary

Modifier and TypeField and Description
private int
private final List<IndexBuilder>
private int
private int
private byte

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public void
public IndexBuilder
public int
public List<IndexBuilder>
public int
public int
public byte
public void
setIndexDataNumber(int newIndexDataNumber)

public void
setRootPageNumber(int newRootPageNumber)

public void
setUmapPageNumber(int newUmapPageNumber)

public void
setUmapRowNumber(byte newUmapRowNumber)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

indexDataNumberback to summary
private int indexDataNumber
indexesback to summary
private final List<IndexBuilder> indexes
rootPageNumberback to summary
private int rootPageNumber
umapPageNumberback to summary
private int umapPageNumber
umapRowNumberback to summary
private byte umapRowNumber

Constructor Detail

IndexDataStateback to summary
pack-priv IndexDataState()

Method Detail

addIndexback to summary
public void addIndex(IndexBuilder idx)
getFirstIndexback to summary
public IndexBuilder getFirstIndex()
getIndexDataNumberback to summary
public int getIndexDataNumber()
getIndexesback to summary
public List<IndexBuilder> getIndexes()
getRootPageNumberback to summary
public int getRootPageNumber()
getUmapPageNumberback to summary
public int getUmapPageNumber()
getUmapRowNumberback to summary
public byte getUmapRowNumber()
setIndexDataNumberback to summary
public void setIndexDataNumber(int newIndexDataNumber)
setRootPageNumberback to summary
public void setRootPageNumber(int newRootPageNumber)
setUmapPageNumberback to summary
public void setUmapPageNumber(int newUmapPageNumber)
setUmapRowNumberback to summary
public void setUmapRowNumber(byte newUmapRowNumber)