com.healthmarketscience.jackcess.complex
Interface ComplexValue

All Known Subinterfaces:
Attachment, SingleValue, UnsupportedValue, Version

public interface ComplexValue

Base interface for a value in a complex column (where there may be multiple values for a single row in the main table).

Author:
James Ahlborn

Nested Class Summary
static class ComplexValue.Id
          Identifier for a ComplexValue.
 
Method Summary
 void delete()
          Deletes the data for this complex value from the database.
 Column getColumn()
           
 ComplexValueForeignKey getComplexValueForeignKey()
          Returns the foreign key identifier for this complex value (this value is the same for all values in the same row of the main table).
 ComplexValue.Id getId()
          Returns the unique identifier of this complex value (this value is unique among all values in all rows of the main table).
 void setComplexValueForeignKey(ComplexValueForeignKey complexValueFk)
           
 void setId(ComplexValue.Id newId)
          Called once when a new ComplexValue is saved to set the new unique identifier.
 void update()
          Writes any updated data for this complex value to the database.
 

Method Detail

getId

ComplexValue.Id getId()
Returns the unique identifier of this complex value (this value is unique among all values in all rows of the main table).

Returns:
the current id or ComplexColumnInfoImpl.INVALID_ID for a new, unsaved value.

setId

void setId(ComplexValue.Id newId)
Called once when a new ComplexValue is saved to set the new unique identifier.


getComplexValueForeignKey

ComplexValueForeignKey getComplexValueForeignKey()
Returns the foreign key identifier for this complex value (this value is the same for all values in the same row of the main table).

Returns:
the current id or ComplexColumnInfoImpl.INVALID_FK for a new, unsaved value.

setComplexValueForeignKey

void setComplexValueForeignKey(ComplexValueForeignKey complexValueFk)

getColumn

Column getColumn()
Returns:
the column in the main table with which this complex value is associated

update

void update()
            throws IOException
Writes any updated data for this complex value to the database.

Throws:
IOException

delete

void delete()
            throws IOException
Deletes the data for this complex value from the database.

Throws:
IOException


Copyright © 2005–2017 Health Market Science. All rights reserved.