Package convex.core.data

Class ARecordGeneric

java.lang.Object

convex.core.data.AObject

convex.core.data.ACell

convex.core.data.ACountable<MapEntry<Keyword,ACell>>

convex.core.data.ADataStructure<MapEntry<Keyword,ACell>>

convex.core.data.AMap<Keyword,ACell>

convex.core.data.ARecord

convex.core.data.ARecordGeneric

All Implemented Interfaces:

IAssociative<Keyword,ACell>, IValidated, IWriteable, Map<Keyword,ACell>

Direct Known Subclasses:

Result

public abstract class ARecordGeneric
extends ARecord

Abstract base class for generic records. Generic records are backed by a Vector of values

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
protected final RecordFormat	format
protected AVector<ACell>	values

Fields inherited from class convex.core.data.ARecord

DEFAULT_VALUE

Fields inherited from class convex.core.data.ADataStructure

count

Fields inherited from class convex.core.data.ACell

cachedRef, memorySize

Fields inherited from class convex.core.data.AObject

encoding

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ARecordGeneric(RecordFormat format, AVector<ACell> values)

Method Summary

Modifier and Type	Method	Description
int	encodeRaw(byte[] bs, int pos)	Writes the raw fields of this record in declared order
MapEntry<Keyword,ACell>	entryAt(long i)	Gets the entry in this map at a specified index, according to the map-specific order.
boolean	equals(ACell a)	Checks for equality with another Cell.
protected boolean	equals(ARecordGeneric a)
ACell	get(Keyword key)	Gets the record field content for a given key, or null if not found.
<R extends ACell> Ref<R>	getRef(int index)	Gets a numbered child Ref from within this Cell.
int	getRefCount()	Gets the number of Refs contained within this Cell.
abstract byte	getTag()	Gets the tag byte for this record type.
ARecord	updateRefs(IRefFunction func)	Updates all Refs in this object using the given function.
void	validateCell()	Validates the local structure and invariants of this cell.
AVector<ACell>	values()	Gets a vector of values for this Record, in format-determined order
protected abstract ARecord	withValues(AVector<ACell> newValues)	Updates the record with a new set of values.

Methods inherited from class convex.core.data.ARecord

accumulateEntrySet, accumulateKeySet, accumulateValues, assoc, assocEntry, containsKey, containsValue, dissoc, dissoc, empty, entrySet, estimatedEncodingSize, forEach, get, getEntry, getEntryByHash, getFormat, getKeyRefEntry, getKeys, getType, getValuesArray, isCanonical, isCVMValue, keySet, reduceEntries, reduceValues, toCanonical, toHashMap

Methods inherited from class convex.core.data.AMap

clear, conj, containsKey, containsKeyRef, containsValue, entryVector, filterValues, get, get, get, getElementRef, merge, print, put, putAll, remove, slice, slice

Methods inherited from class convex.core.data.ADataStructure

checkIndex, conjAll, count, isDataValue, isEmpty, size, toCVMString

Methods inherited from class convex.core.data.ACell

attachMemorySize, attachRef, cachedEncoding, cachedHash, calcMemorySize, createEncoding, createRef, encode, equals, genericEquals, getCanonical, getChildRefs, getEncoding, getEncodingLength, getHash, getMemorySize, getMemorySize, getRef, hashCode, isEmbedded, toString, validate

Methods inherited from class convex.core.data.AObject

attachEncoding, print, print

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAll, size

Field Details

values

protected AVector<ACell> values

format

protected final RecordFormat format

Constructor Details

ARecordGeneric

protected ARecordGeneric(RecordFormat format,
 AVector<ACell> values)

Method Details

entryAt

public MapEntry<Keyword,ACell> entryAt(long i)

Description copied from class: AMap

Gets the entry in this map at a specified index, according to the map-specific order. Caller responsible for bounds check!

Overrides:

entryAt in class ARecord

Parameters:

i - Index of entry

Returns:

MapEntry at the specified index.

get

public ACell get(Keyword key)

Description copied from class: ARecord

Gets the record field content for a given key, or null if not found.

Specified by:

get in class ARecord

Parameters:

key - Key to look up in this record

Returns:

Field value for the given key

getTag

public abstract byte getTag()

Description copied from class: ARecord

Gets the tag byte for this record type. The Tag is the byte used to identify the record in the binary encoding.

Specified by:

getTag in class ARecord

Returns:

Record tag byte

getRefCount

public int getRefCount()

Description copied from class: ACell

Gets the number of Refs contained within this Cell. This number is final / immutable for any given instance and is defined by the Cell encoding rules. Contained Refs may be either external or embedded.

Overrides:

getRefCount in class ACell

Returns:

The number of Refs in this Cell

encodeRaw

public int encodeRaw(byte[] bs,
 int pos)

Writes the raw fields of this record in declared order

Specified by:

encodeRaw in class ACell

Parameters:

bs - Array to write to

pos - The offset into the byte array

Returns:

New position after writing

equals

public boolean equals(ACell a)

Description copied from class: ACell

Checks for equality with another Cell. In general, Cells are considered equal if they have the same canonical representation, i.e. an identical encoding with the same hash value. Subclasses SHOULD override this if they have a more efficient equals implementation. MUST NOT require reads from Store.

Specified by:

equals in class ACell

Parameters:

a - Cell to compare with. May be null.

Returns:

True if this cell is equal to the other object

equals

protected boolean equals(ARecordGeneric a)

getRef

public <R extends ACell> Ref<R> getRef(int index)

Description copied from class: ACell

Gets a numbered child Ref from within this Cell. WARNING: May need to convert to a canonical instance

Overrides:

getRef in class ACell

Type Parameters:

R - Type of referenced Cell

Parameters:

index - Index of ref to get

Returns:

The Ref at the specified index

updateRefs

public ARecord updateRefs(IRefFunction func)

Description copied from class: ACell

Updates all Refs in this object using the given function. The function *must not* change the hash value of Refs, in order to ensure structural integrity of modified data structures. The implementation *should* re-attach any original encoding in order to prevent re-encoding or surplus hashing This is a building block for a very sneaky trick that enables use to do a lot of efficient operations on large trees of smart references. Must return the same object if no Refs are altered.

Overrides:

updateRefs in class ACell

Parameters:

func - Ref update function

Returns:

Cell with updated Refs

values

public AVector<ACell> values()

Description copied from class: ARecord

Gets a vector of values for this Record, in format-determined order

Specified by:

values in interface Map<Keyword,ACell>

Overrides:

values in class ARecord

Returns:

Vector of Values

withValues

protected abstract ARecord withValues(AVector<ACell> newValues)

Updates the record with a new set of values. Returns this if and only if values vector is identical.

Parameters:

newValues - New values to use

Returns:

Updated Record

validateCell

public void validateCell()
                  throws InvalidDataException

Description copied from class: ACell

Validates the local structure and invariants of this cell. Called by validate() super implementation. Should validate directly contained data, but should not validate all other structure of this cell. In particular, should not traverse potentially missing child Refs.

Specified by:

validateCell in class ACell

Throws:

InvalidDataException - If the Cell is invalid