gudusoft.gsqlparser.lineage.v2.identity

Class IdentityV1

Object

gudusoft.gsqlparser.lineage.v2.identity.IdentityV1

public final class IdentityV1
extends Object

The identity algorithm family PUBLIC-LINEAGE-ID-V1 (lineage-spec/algorithms/identity-v1.md).

Each algorithm takes its inputs as a JSON value in the shape of the specification's vectors and of the reference implementation (sqllr_ids.py, compute), validates them in the reference's order, and returns an IdentityV1.IdResult: the identity status, and the framed input, digest, id and numeric key when an id is computed. Canonical segment keys are inputs; minting them belongs to the producer.

Since:

4.2.17

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IdentityV1.IdResult The outcome of one algorithm run.

Field Summary

Fields

Modifier and Type	Field and Description
static List<String>	ALGORITHMS The algorithms in the order of Section 2.
static String	ANALYSIS_CONTEXT
static List<String>	ANALYSIS_FEATURES
static List<String>	BOM_HANDLING
static List<String>	CANDIDATE_SET_MEMBERSHIP
static List<String>	CAPABILITY_STATUSES
static String	DEPENDENCY_SNAPSHOT
static List<String>	DIGEST_DOMAINS
static String	ENDPOINT
static String	EXPLAIN_NODE_KEY
static List<String>	EXPLAIN_NODE_KINDS
static String	EXPLAIN_NODE_RECORD
static String	FACT
static List<String>	FACT_KINDS
static String	FAMILY
static Map<String,String>	IDENTITY_CLASS Endpoint kind (registry group endpointKinds) to identity class (Section 5.2.1); a kind mapped to null has no identity class in V1 and is LOCAL.
static List<String>	LINE_ENDING_HANDLING
static String	LOCAL
static String	METADATA_DIGEST
static List<String>	METADATA_STATUSES
static List<String>	NON_PORTABLE
static String	OCCURRENCE_KEY
static String	OCCURRENCE_RECORD
static String	OPAQUE_PRODUCER_LOCAL
static List<String>	PARAMETER_MODES
static String	PATH_PROFILE_V1
static List<String>	PATH_SEGMENT_KINDS
static List<String>	PATH_STEP_CODES
static String	PORTABLE
static Map<String,String>	PREFIXES Algorithm name to the prefix of its ids.
static List<String>	ROUTINE_KINDS
static List<String>	ROUTINE_NAMESPACES
static List<String>	ROW_ROLES
static List<String>	SIGNATURE_FORMS
static String	SOURCE_UNIT
static String	UNAVAILABLE_COLLATION
static String	UNAVAILABLE_MIXED_PROFILE

Method Summary

Modifier and Type	Method and Description
static void	checkNumericKeys(Collection<?> ids) The importer rule of Section 5.10: two different ids with one numeric key are a fatal collision.
static IdentityV1.IdResult	compute(String algorithm, Object inputs) Runs one algorithm on its inputs.
static boolean	isId(Object value, String prefix) True for a well-formed id with this prefix.
static String	numericKey(Object id) NumericKeyV1 (Section 5.10): the first 16 bytes of the digest of an id, as 32 lowercase hexadecimal characters.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FAMILY

public static final String FAMILY

See Also:

Constant Field Values

PATH_PROFILE_V1

public static final String PATH_PROFILE_V1

See Also:

Constant Field Values

SOURCE_UNIT

public static final String SOURCE_UNIT

See Also:

Constant Field Values

ENDPOINT

public static final String ENDPOINT

See Also:

Constant Field Values

FACT

public static final String FACT

See Also:

Constant Field Values

OCCURRENCE_KEY

public static final String OCCURRENCE_KEY

See Also:

Constant Field Values

ANALYSIS_CONTEXT

public static final String ANALYSIS_CONTEXT

See Also:

Constant Field Values

OCCURRENCE_RECORD

public static final String OCCURRENCE_RECORD

See Also:

Constant Field Values

EXPLAIN_NODE_KEY

public static final String EXPLAIN_NODE_KEY

See Also:

Constant Field Values

EXPLAIN_NODE_RECORD

public static final String EXPLAIN_NODE_RECORD

See Also:

Constant Field Values

DEPENDENCY_SNAPSHOT

public static final String DEPENDENCY_SNAPSHOT

See Also:

Constant Field Values

METADATA_DIGEST

public static final String METADATA_DIGEST

See Also:

Constant Field Values

PREFIXES

public static final Map<String,String> PREFIXES

Algorithm name to the prefix of its ids.

PORTABLE

public static final String PORTABLE

See Also:

Constant Field Values

LOCAL

public static final String LOCAL

See Also:

Constant Field Values

UNAVAILABLE_COLLATION

public static final String UNAVAILABLE_COLLATION

See Also:

Constant Field Values

UNAVAILABLE_MIXED_PROFILE

public static final String UNAVAILABLE_MIXED_PROFILE

See Also:

Constant Field Values

OPAQUE_PRODUCER_LOCAL

public static final String OPAQUE_PRODUCER_LOCAL

See Also:

Constant Field Values

FACT_KINDS

public static final List<String> FACT_KINDS

ROW_ROLES

public static final List<String> ROW_ROLES

NON_PORTABLE

public static final List<String> NON_PORTABLE

DIGEST_DOMAINS

public static final List<String> DIGEST_DOMAINS

METADATA_STATUSES

public static final List<String> METADATA_STATUSES

ANALYSIS_FEATURES

public static final List<String> ANALYSIS_FEATURES

CAPABILITY_STATUSES

public static final List<String> CAPABILITY_STATUSES

BOM_HANDLING

public static final List<String> BOM_HANDLING

LINE_ENDING_HANDLING

public static final List<String> LINE_ENDING_HANDLING

ROUTINE_NAMESPACES

public static final List<String> ROUTINE_NAMESPACES

ROUTINE_KINDS

public static final List<String> ROUTINE_KINDS

SIGNATURE_FORMS

public static final List<String> SIGNATURE_FORMS

PARAMETER_MODES

public static final List<String> PARAMETER_MODES

PATH_SEGMENT_KINDS

public static final List<String> PATH_SEGMENT_KINDS

CANDIDATE_SET_MEMBERSHIP

public static final List<String> CANDIDATE_SET_MEMBERSHIP

PATH_STEP_CODES

public static final List<String> PATH_STEP_CODES

EXPLAIN_NODE_KINDS

public static final List<String> EXPLAIN_NODE_KINDS

IDENTITY_CLASS

public static final Map<String,String> IDENTITY_CLASS

Endpoint kind (registry group endpointKinds) to identity class (Section 5.2.1); a kind mapped to null has no identity class in V1 and is LOCAL.

ALGORITHMS

public static final List<String> ALGORITHMS

The algorithms in the order of Section 2.

Method Detail

compute

public static IdentityV1.IdResult compute(String algorithm,
                                          Object inputs)

Runs one algorithm on its inputs.

Parameters:

algorithm - one of the names of Section 2, such as EndpointIdV1

Throws:

SqllrException - with an ID_* code (or a SCHEMA_* code for JSON that canonical JSON cannot carry) when the inputs are rejected

numericKey

public static String numericKey(Object id)

NumericKeyV1 (Section 5.10): the first 16 bytes of the digest of an id, as 32 lowercase hexadecimal characters.

Throws:

SqllrException - ID_INVALID_REFERENCE for a string that is not an id of the family

checkNumericKeys

public static void checkNumericKeys(Collection<?> ids)

The importer rule of Section 5.10: two different ids with one numeric key are a fatal collision.

Throws:

SqllrException - ID_NUMERIC_KEY_COLLISION

isId

public static boolean isId(Object value,
                           String prefix)

True for a well-formed id with this prefix.