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

public abstract Class ComplexValueForeignKey

extends Number
Class Inheritance
Known Direct Subclasses
io.github.spannm.jackcess.impl.complex.ComplexValueForeignKeyImpl
Imports
io.github.spannm.jackcess.Column, .DateTimeType, java.io.IOException, .ObjectStreamException, java.time.LocalDateTime, java.util.Date, .List, .Map

Value which is returned for a complex column. This value corresponds to a foreign key in a secondary table which contains the actual complex data for this row (which could be 0 or more complex values for a given row). This class contains various convenience methods for interacting with the actual complex values.

This class will cache the associated complex values returned from one of the lookup methods. The various modification methods will clear this cache automatically. The reset method may be called manually to clear this internal cache.

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public abstract Attachment
addAttachment(byte[] data)

public abstract Attachment
addAttachment(String url, String name, String type, byte[] data, Date timeStamp, Integer flags)
Deprecated see DateTimeType for details

public abstract Attachment
addAttachment(String url, String name, String type, byte[] data, LocalDateTime timeStamp, Integer flags)

public abstract Attachment
addEncodedAttachment(byte[] encodedData)

public abstract Attachment
addEncodedAttachment(String url, String name, String type, byte[] encodedData, Date timeStamp, Integer flags)
Deprecated see DateTimeType for details

public abstract Attachment
addEncodedAttachment(String url, String name, String type, byte[] encodedData, LocalDateTime timeStamp, Integer flags)

public abstract SingleValue
public abstract UnsupportedValue
public abstract Version
public abstract Version
addVersion(String value, Date modifiedDate)
Deprecated see DateTimeType for details

public abstract Version
addVersion(String value, LocalDateTime modifiedDate)

public byte
byteValue()

Overrides java.lang.Number.byteValue.

Returns the value of the specified number as a byte.

public abstract int
public abstract void
public abstract Attachment
public abstract SingleValue
public abstract UnsupportedValue
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()

public abstract List<Attachment>
public abstract Column
public abstract ComplexDataType
public abstract List<SingleValue>
public abstract List<UnsupportedValue>
public abstract List<? extends ComplexValue>
public abstract List<Version>
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 abstract void
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.

public abstract Attachment
public abstract SingleValue
public abstract UnsupportedValue
protected final Object

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.lang.Number.serialVersionUID.

Constructor Detail

ComplexValueForeignKeyback to summary
public ComplexValueForeignKey()

Method Detail

addAttachmentback to summary
public abstract Attachment addAttachment(byte[] data) throws IOException
addAttachmentback to summary
public abstract Attachment addAttachment(String url, String name, String type, byte[] data, Date timeStamp, Integer flags) throws IOException

Deprecated

see DateTimeType for details

Annotations
@Deprecated
addAttachmentback to summary
public abstract Attachment addAttachment(String url, String name, String type, byte[] data, LocalDateTime timeStamp, Integer flags) throws IOException
addEncodedAttachmentback to summary
public abstract Attachment addEncodedAttachment(byte[] encodedData) throws IOException
addEncodedAttachmentback to summary
public abstract Attachment addEncodedAttachment(String url, String name, String type, byte[] encodedData, Date timeStamp, Integer flags) throws IOException

Deprecated

see DateTimeType for details

Annotations
@Deprecated
addEncodedAttachmentback to summary
public abstract Attachment addEncodedAttachment(String url, String name, String type, byte[] encodedData, LocalDateTime timeStamp, Integer flags) throws IOException
addMultiValueback to summary
public abstract SingleValue addMultiValue(Object value) throws IOException
addUnsupportedValueback to summary
public abstract UnsupportedValue addUnsupportedValue(Map<String, ?> values) throws IOException
addVersionback to summary
public abstract Version addVersion(String value) throws IOException
addVersionback to summary
public abstract Version addVersion(String value, Date modifiedDate) throws IOException

Deprecated

see DateTimeType for details

Annotations
@Deprecated
addVersionback to summary
public abstract Version addVersion(String value, LocalDateTime modifiedDate) throws IOException
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
countValuesback to summary
public abstract int countValues() throws IOException
deleteAllValuesback to summary
public abstract void deleteAllValues() throws IOException
deleteAttachmentback to summary
public abstract Attachment deleteAttachment(Attachment attachment) throws IOException
deleteMultiValueback to summary
public abstract SingleValue deleteMultiValue(SingleValue value) throws IOException
deleteUnsupportedValueback to summary
public abstract UnsupportedValue deleteUnsupportedValue(UnsupportedValue value) throws IOException
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()
getAttachmentsback to summary
public abstract List<Attachment> getAttachments() throws IOException
getColumnback to summary
public abstract Column getColumn()
getComplexTypeback to summary
public abstract ComplexDataType getComplexType()
getMultiValuesback to summary
public abstract List<SingleValue> getMultiValues() throws IOException
getUnsupportedValuesback to summary
public abstract List<UnsupportedValue> getUnsupportedValues() throws IOException
getValuesback to summary
public abstract List<? extends ComplexValue> getValues() throws IOException
getVersionsback to summary
public abstract List<Version> getVersions() throws IOException
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
resetback to summary
public abstract void reset()
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
updateAttachmentback to summary
public abstract Attachment updateAttachment(Attachment attachment) throws IOException
updateMultiValueback to summary
public abstract SingleValue updateMultiValue(SingleValue value) throws IOException
updateUnsupportedValueback to summary
public abstract UnsupportedValue updateUnsupportedValue(UnsupportedValue value) throws IOException
writeReplaceback to summary
protected final Object writeReplace() throws ObjectStreamException