gudusoft.gsqlparser.lineage.v2.producer

Class SqllrInput

Object

gudusoft.gsqlparser.lineage.v2.producer.SqllrInput

public final class SqllrInput
extends Object

One source unit given to the SQL-LR producer: its identity and its text (specification Section 7.8).

• NAMED: the caller names the unit by namespace + logicalName (for example a repository and a path relative to it). This is the portable identity; the content digest only identifies the version.
• CONTENT_ADDRESSED: the caller declares that within contextDomain equal content is one unit (for example entries of a query log).
• LOCAL: everything else, such as an unnamed file; valid only within the document. A producer never makes an unnamed file content-addressed by itself.

The text is analysed exactly as decoded: no character is replaced, a byte order mark is removed and declared (BOM_STRIPPED), and line endings are kept (PRESERVED). Two inputs with equal text remain two units. Immutable.

Since:

4.2.17

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_ADDRESSED
static String	LOCAL
static String	NAMED

Method Summary

Modifier and Type	Method and Description
static SqllrInput	contentAddressed(String contextDomain, String text) A content-addressed unit: the caller declares that equal content within the domain is one unit.
String	decodedTextDigest() SHA-256 of the UTF-8 encoding of the decoded text (DECODED_TEXT_SHA256).
boolean	equals(Object other) Two inputs are equal only when they are the same object: equal text never merges two units.
String	getBom() NO_BOM or BOM_STRIPPED.
String	getContextDomain()
String	getIdentityKind()
String	getLogicalName()
String	getNamespace()
byte[]	getRawBytes() The raw bytes, when given; a copy.
String	getText() The decoded text the analysis reads.
int	hashCode()
static SqllrInput	local(byte[] utf8) A unit with no identity beyond the document, from UTF-8 bytes.
static SqllrInput	local(String text) A unit with no identity beyond the document; the text is the whole content, with no byte order mark.
static SqllrInput	local(String text, String bom) A unit with no identity beyond the document, declaring the byte order mark handling.
static SqllrInput	named(String namespace, String logicalName, byte[] utf8) A named unit from UTF-8 bytes; a leading byte order mark is removed and declared.
static SqllrInput	named(String namespace, String logicalName, String text) A named unit from already-decoded text that is the whole content of the source, with no byte order mark (NO_BOM); no raw-bytes digest is published.
static SqllrInput	named(String namespace, String logicalName, String text, String bom) A named unit from already-decoded text, declaring how a byte order mark was handled: NO_BOM (the raw bytes had none) or BOM_STRIPPED (the caller removed one; it is not part of the text).
String	rawBytesDigest() SHA-256 of the raw bytes (RAW_BYTES_SHA256), or null when only text was given.
String	toString()

Methods inherited from class Object

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

Field Detail

NAMED

public static final String NAMED

See Also:

Constant Field Values

CONTENT_ADDRESSED

public static final String CONTENT_ADDRESSED

See Also:

Constant Field Values

LOCAL

public static final String LOCAL

See Also:

Constant Field Values

Method Detail

named

public static SqllrInput named(String namespace,
                               String logicalName,
                               String text)

A named unit from already-decoded text that is the whole content of the source, with no byte order mark (NO_BOM); no raw-bytes digest is published. Use named(String, String, String, String) when the caller removed a byte order mark while decoding.

named

public static SqllrInput named(String namespace,
                               String logicalName,
                               String text,
                               String bom)

A named unit from already-decoded text, declaring how a byte order mark was handled: NO_BOM (the raw bytes had none) or BOM_STRIPPED (the caller removed one; it is not part of the text).

named

public static SqllrInput named(String namespace,
                               String logicalName,
                               byte[] utf8)

A named unit from UTF-8 bytes; a leading byte order mark is removed and declared.

contentAddressed

public static SqllrInput contentAddressed(String contextDomain,
                                          String text)

A content-addressed unit: the caller declares that equal content within the domain is one unit.

local

public static SqllrInput local(String text)

A unit with no identity beyond the document; the text is the whole content, with no byte order mark.

local

public static SqllrInput local(String text,
                               String bom)

A unit with no identity beyond the document, declaring the byte order mark handling.

local

public static SqllrInput local(byte[] utf8)

A unit with no identity beyond the document, from UTF-8 bytes.

getIdentityKind

public String getIdentityKind()

getNamespace

public String getNamespace()

getLogicalName

public String getLogicalName()

getContextDomain

public String getContextDomain()

getText

public String getText()

The decoded text the analysis reads.

getBom

public String getBom()

NO_BOM or BOM_STRIPPED.

getRawBytes

public byte[] getRawBytes()

The raw bytes, when given; a copy.

rawBytesDigest

public String rawBytesDigest()

SHA-256 of the raw bytes (RAW_BYTES_SHA256), or null when only text was given.

decodedTextDigest

public String decodedTextDigest()

SHA-256 of the UTF-8 encoding of the decoded text (DECODED_TEXT_SHA256).

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Two inputs are equal only when they are the same object: equal text never merges two units.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object