Package com.healthmarketscience.jackcess.impl

Class TableNameMapImpl

java.lang.Object

com.healthmarketscience.jackcess.impl.NameMapImpl

com.healthmarketscience.jackcess.impl.TableNameMapImpl

All Implemented Interfaces:

NameMap, TableNameMap, Iterable<NameMap.Record>

public class TableNameMapImpl
extends NameMapImpl
implements TableNameMap

The name map of a table, which can be changed and saved back into the property of the table.

Author:

James Ahlborn

Usage:

Advanced: This class is for advanced/internal use.

Nested Class Summary

Nested classes/interfaces inherited from interface com.healthmarketscience.jackcess.NameMap

NameMap.Mismatch, NameMap.MismatchType, NameMap.Record, NameMap.RecordType

Method Summary

Modifier and Type	Method	Description
NameMap.Record	addColumn(String name, String guid)	Adds a column record before the end record.
List<NameMap.Mismatch>	findMismatches()	Compares the table and column records with the table which holds this name map.
NameMap.Record	getColumnRecord(String name)
List<NameMap.Record>	getReferences()
NameMap.Record	getTableRecord()
static TableNameMapImpl	read(byte[] bytes, TableImpl table)
NameMap.Record	removeColumn(String name)	Removes the column record with the given name (case-insensitive).
void	save()	Writes the name map into the table property and saves the properties of the table.

Methods inherited from class com.healthmarketscience.jackcess.impl.NameMapImpl

getColumnRecords, getRecord, getTableRecords, getWriterTag, iterator, toBytes, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface com.healthmarketscience.jackcess.NameMap

getColumnRecords, getRecord, getTableRecords, getWriterTag, stream

Method Detail

read

public static TableNameMapImpl read(byte[] bytes,
                                    TableImpl table)
                             throws IOException

Parameters:

bytes - the value of the name map property of a table

table - the table which holds the property

Returns:

the decoded name map

Throws:

IOException - if the bytes are not a valid name map

getTableRecord

public NameMap.Record getTableRecord()

Specified by:

getTableRecord in interface TableNameMap

Returns:

the record for the table, or null if there is none

getColumnRecord

public NameMap.Record getColumnRecord(String name)

Specified by:

getColumnRecord in interface TableNameMap

Returns:

the column record with the given name (case-insensitive), or null if there is none

getReferences

public List<NameMap.Record> getReferences()

Specified by:

getReferences in interface TableNameMap

Returns:

the records for the names which expressions in the table use, in the order of the name map

addColumn

public NameMap.Record addColumn(String name,
                                String guid)

Description copied from interface: TableNameMap

Adds a column record before the end record.

Specified by:

addColumn in interface TableNameMap

Parameters:

name - the column name

guid - the guid of the column, which must be the same as the "GUID" property of the column

Returns:

the new record

removeColumn

public NameMap.Record removeColumn(String name)

Description copied from interface: TableNameMap

Removes the column record with the given name (case-insensitive).

Specified by:

removeColumn in interface TableNameMap

Returns:

the removed record, or null if there is none

findMismatches

public List<NameMap.Mismatch> findMismatches()
                                      throws IOException

Description copied from interface: TableNameMap

Compares the table and column records with the table which holds this name map. A column is found by its guid, and by its name when it has no guid or no record carries it.

Specified by:

findMismatches in interface NameMap

Specified by:

findMismatches in interface TableNameMap

Returns:

every difference, empty if the name map agrees with the table

Throws:

IOException

save

public void save()
          throws IOException

Description copied from interface: TableNameMap

Writes the name map into the table property and saves the properties of the table.

Specified by:

save in interface TableNameMap

Throws:

IOException