APIdia Launch Partner
Top Description Inners Methods
io.github.spannm.jackcess.complex

public Interface ComplexValue

Known Direct Subinterfaces
io.github.spannm.jackcess.complex.SingleValue, io.github.spannm.jackcess.complex.UnsupportedValue, io.github.spannm.jackcess.complex.Version, io.github.spannm.jackcess.complex.Attachment
Known Direct Implementers
io.github.spannm.jackcess.impl.complex.ComplexColumnInfoImpl.ComplexValueImpl
Imports
io.github.spannm.jackcess.Column, .RowId, io.github.spannm.jackcess.impl.complex.ComplexColumnInfoImpl, java.io.IOException, .ObjectStreamException

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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public abstract static class
ComplexValue.Id

Identifier for a ComplexValue.

Method Summary

Modifier and TypeMethod and Description
public void
delete()

Deletes the data for this complex value from the database.

public Column

Returns:

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

Returns the column in the main table with which this complex value is associated.

public ComplexValueForeignKey

Returns:

the current id or ComplexColumnInfoImpl#INVALID_FK for a new, unsaved value.
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).

public ComplexValue.Id

Returns:

the current id or ComplexColumnInfoImpl#INVALID_ID for a new, unsaved value.
getId
()

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

public void
public void
setId(ComplexValue.Id newId)

Called once when a new ComplexValue is saved to set the new unique identifier.

public void
update()

Writes any updated data for this complex value to the database.

Method Detail

deleteback to summary
public void delete() throws IOException

Deletes the data for this complex value from the database.

getColumnback to summary
public Column getColumn()

Returns the column in the main table with which this complex value is associated.

Returns:Column

the column in the main table with which this complex value is associated

getComplexValueForeignKeyback to summary
public 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:ComplexValueForeignKey

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

getIdback to summary
public 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:ComplexValue.Id

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

setComplexValueForeignKeyback to summary
public void setComplexValueForeignKey(ComplexValueForeignKey complexValueFk)
setIdback to summary
public void setId(ComplexValue.Id newId)

Called once when a new ComplexValue is saved to set the new unique identifier.

updateback to summary
public void update() throws IOException

Writes any updated data for this complex value to the database.

io.github.spannm.jackcess.complex back to summary

public abstract Class ComplexValue.Id

extends Number
Class Inheritance
Known Direct Subclasses
io.github.spannm.jackcess.impl.complex.ComplexColumnInfoImpl.ComplexValueIdImpl

Identifier for a ComplexValue. Only valid for comparing complex values for the same column.

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
public
Id()

Method Summary

Modifier and TypeMethod and Description
public byte
byteValue()

Overrides java.lang.Number.byteValue.

Returns the value of the specified number as a byte.

public double
doubleValue()

Implements abstract java.lang.Number.doubleValue.

Returns the value of the specified number as a double.

public boolean
equals(Object o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public float
floatValue()

Implements abstract java.lang.Number.floatValue.

Returns the value of the specified number as a float.

public abstract int
get()

Returns the unique identifier of this complex value (this value is unique among all values in all rows of the main table for the complex column).

public abstract RowId
getRowId()

Returns the rowId of this ComplexValue within the secondary table.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public int
intValue()

Implements abstract java.lang.Number.intValue.

Returns the value of the specified number as an int.

public long
longValue()

Implements abstract java.lang.Number.longValue.

Returns the value of the specified number as a long.

public short
shortValue()

Overrides java.lang.Number.shortValue.

Returns the value of the specified number as a short.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

protected final Object

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.lang.Number.serialVersionUID.

Constructor Detail

Idback to summary
public Id()

Method Detail

byteValueback to summary
public byte byteValue()

Overrides java.lang.Number.byteValue.

Doc from java.lang.Number.byteValue.

Returns the value of the specified number as a byte.

Annotations
@Override
doubleValueback to summary
public double doubleValue()

Implements abstract java.lang.Number.doubleValue.

Doc from java.lang.Number.doubleValue.

Returns the value of the specified number as a double.

Annotations
@Override
equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations
@Override
floatValueback to summary
public float floatValue()

Implements abstract java.lang.Number.floatValue.

Doc from java.lang.Number.floatValue.

Returns the value of the specified number as a float.

Annotations
@Override
getback to summary
public abstract int get()

Returns the unique identifier of this complex value (this value is unique among all values in all rows of the main table for the complex column).

getRowIdback to summary
public abstract RowId getRowId()

Returns the rowId of this ComplexValue within the secondary table.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Annotations
@Override
intValueback to summary
public int intValue()

Implements abstract java.lang.Number.intValue.

Doc from java.lang.Number.intValue.

Returns the value of the specified number as an int.

Annotations
@Override
longValueback to summary
public long longValue()

Implements abstract java.lang.Number.longValue.

Doc from java.lang.Number.longValue.

Returns the value of the specified number as a long.

Annotations
@Override
shortValueback to summary
public short shortValue()

Overrides java.lang.Number.shortValue.

Doc from java.lang.Number.shortValue.

Returns the value of the specified number as a short.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations
@Override
writeReplaceback to summary
protected final Object writeReplace() throws ObjectStreamException