corda / net.corda.core.node.services.vault

Package net.corda.core.node.services.vault

Supporting data types for the vault services.

Types

AggregateFunctionType

enum class AggregateFunctionType

AttachmentQueryCriteria

sealed class AttachmentQueryCriteria : GenericQueryCriteria<AttachmentQueryCriteria, AttachmentsQueryCriteriaParser>, ChainableQueryCriteria<AttachmentQueryCriteria, AttachmentsQueryCriteriaParser>

AttachmentSort

data class AttachmentSort : BaseSort

AttachmentsQueryCriteriaParser

interface AttachmentsQueryCriteriaParser : BaseQueryCriteriaParser<AttachmentQueryCriteria, AttachmentsQueryCriteriaParser, AttachmentSort>

BaseQueryCriteriaParser

interface BaseQueryCriteriaParser<Q : GenericQueryCriteria<Q, P>, in P : BaseQueryCriteriaParser<Q, P, S>, in S : BaseSort>

BaseSort

abstract class BaseSort

BinaryComparisonOperator

enum class BinaryComparisonOperator : Operator

BinaryLogicalOperator

enum class BinaryLogicalOperator : Operator

Builder

object Builder

CollectionOperator

enum class CollectionOperator : Operator

Column

class Column<O, out C>

ColumnPredicate

sealed class ColumnPredicate<C>

CriteriaExpression

sealed class CriteriaExpression<O, out T>

EqualityComparisonOperator

enum class EqualityComparisonOperator : Operator

FieldInfo

class FieldInfo

Contains information about a field from an entity class. Used as part of query criteria construction through Builder, produced by function getField. The constructor should not be invoked manually.

GenericQueryCriteria

interface GenericQueryCriteria<Q : GenericQueryCriteria<Q, *>, in P : BaseQueryCriteriaParser<Q, *, *>>

IQueryCriteriaParser

interface IQueryCriteriaParser : BaseQueryCriteriaParser<QueryCriteria, IQueryCriteriaParser, Sort>

LikenessOperator

enum class LikenessOperator : Operator

NullOperator

enum class NullOperator : Operator

Operator

interface Operator

PageSpecification

data class PageSpecification

PageSpecification allows specification of a page number (starting from DEFAULT_PAGE_NUM) and page size (defaulting to DEFAULT_PAGE_SIZE with a maximum page size of MAX_PAGE_SIZE) Note: we default the page number to DEFAULT_PAGE_SIZE to enable queries without requiring a page specification but enabling detection of large results sets that fall out of the DEFAULT_PAGE_SIZE requirement. MAX_PAGE_SIZE should be used with extreme caution as results may exceed your JVM memory footprint.

QueryCriteria

sealed class QueryCriteria : GenericQueryCriteria<QueryCriteria, IQueryCriteriaParser>, ChainableQueryCriteria<QueryCriteria, IQueryCriteriaParser>

Indexing assumptions: QueryCriteria assumes underlying schema tables are correctly indexed for performance.

Sort

data class Sort : BaseSort

Sort allows specification of a set of entity attribute names and their associated directionality and null handling, to be applied upon processing a query specification.

SortAttribute

sealed class SortAttribute

Properties

DEFAULT_PAGE_NUM

const val DEFAULT_PAGE_NUM: Int

Pagination and Ordering

DEFAULT_PAGE_SIZE

const val DEFAULT_PAGE_SIZE: Int

MAX_PAGE_SIZE

const val MAX_PAGE_SIZE: Int

Note: use PageSpecification to correctly handle a number of bounded pages of a pre-configured page size.

Functions

builder

fun <A> builder(block: Builder.() -> A): A

getColumnName

fun <O, C> getColumnName(column: Column<O, C>): String

getField

fun getField(fieldName: String, entityClass: Class<*>): FieldInfo

Returns a FieldInfo for field with name fieldName in entityClass.

resolveEnclosingObjectFromColumn

fun <O, C> resolveEnclosingObjectFromColumn(column: Column<O, C>): Class<O>

resolveEnclosingObjectFromExpression

fun <O, R> resolveEnclosingObjectFromExpression(expression: CriteriaExpression<O, R>): Class<O>