Class SerializableNumericIdentificationKeyValidator

Serializable numeric identification key validator. Validates both serialized and non-serialized forms of numeric identification keys that support serialization.

Hierarchy (View Summary)

NonGTINNumericIdentificationKeyValidator
- SerializableNumericIdentificationKeyValidator

Index

Constructors

constructor

new SerializableNumericIdentificationKeyValidator(
    identificationKeyType: IdentificationKeyType,
    length: number,
    serialComponentLength: number,
    serialComponentCharacterSet: ContentCharacterSet,
): SerializableNumericIdentificationKeyValidator
Constructor.
Parameters
- identificationKeyType: IdentificationKeyType
  Identification key type.
- length: number
  Length.
- serialComponentLength: number
  Serial component length.
- serialComponentCharacterSet: ContentCharacterSet
  Serial component character set.
Returns SerializableNumericIdentificationKeyValidator
Overrides NonGTINNumericIdentificationKeyValidator.constructor
- Defined in idkey.ts:868

Accessors

serialComponentLength

get serialComponentLength(): number
Get the serial component length.

Returns number
- Defined in idkey.ts:886

serialComponentCharacterSet

get serialComponentCharacterSet(): ContentCharacterSet
Get the serial component character set.

Returns ContentCharacterSet
- Defined in idkey.ts:893

`Protected`serialComponentValidation

get serialComponentValidation(): CharacterSetValidation
Get the serial component validation parameters.

Returns CharacterSetValidation
- Defined in idkey.ts:900

serialComponentCreator

get serialComponentCreator(): CharacterSetCreator
Get the serial component creator.

Returns CharacterSetCreator
- Defined in idkey.ts:907

leaderType

get leaderType(): LeaderType
Returns LeaderType
Inherit Doc
Inherited from NonGTINNumericIdentificationKeyValidator.leaderType
- Defined in idkey.ts:395

identificationKeyType

get identificationKeyType(): IdentificationKeyType
Returns IdentificationKeyType
Inherit Doc
Inherited from NonGTINNumericIdentificationKeyValidator.identificationKeyType
- Defined in idkey.ts:258

prefixType

get prefixType(): PrefixType
Returns PrefixType
Inherit Doc
Inherited from NonGTINNumericIdentificationKeyValidator.prefixType
- Defined in idkey.ts:265

length

get length(): number
Returns number
Inherit Doc
Inherited from NonGTINNumericIdentificationKeyValidator.length
- Defined in idkey.ts:272

referenceCharacterSet

get referenceCharacterSet(): ContentCharacterSet
Returns ContentCharacterSet
Inherit Doc
Inherited from NonGTINNumericIdentificationKeyValidator.referenceCharacterSet
- Defined in idkey.ts:279

referenceCreator

get referenceCreator(): CharacterSetCreator
Returns CharacterSetCreator
Inherit Doc
Inherited from NonGTINNumericIdentificationKeyValidator.referenceCreator
- Defined in idkey.ts:286

Methods

`Protected` `Static`creatorFor

creatorFor(characterSet: ContentCharacterSet): CharacterSetCreator
Get the character set creator for a character set.
Parameters
- characterSet: ContentCharacterSet
  Character set.
Returns CharacterSetCreator
Character set creator.
Inherited from NonGTINNumericIdentificationKeyValidator.creatorFor
- Defined in idkey.ts:228

validate

validate(
identificationKey: string,
validation?: IdentificationKeyValidation,
): void
Parameters
- identificationKey: string
- Optionalvalidation: IdentificationKeyValidation
Returns void
Inherit Doc
Overrides NonGTINNumericIdentificationKeyValidator.validate
- Defined in idkey.ts:914

`Protected`padIdentificationKey

padIdentificationKey(
identificationKey: string,
validation: undefined | IdentificationKeyValidation,
): string
Pad an identification key on the left with zero-value character for validation purposes. This is done to align an identification key with a position offset for any error message that may be thrown by the reference validator.
Parameters
- identificationKey: string
  Identification key.
- validation: undefined | IdentificationKeyValidation
  Identification key validation parameters.
Returns string
Padded identification key.
Inherited from NonGTINNumericIdentificationKeyValidator.padIdentificationKey
- Defined in idkey.ts:303

`Protected`validatePrefix

validatePrefix(partialIdentificationKey: string, positionOffset?: number): void
Validate the prefix within an identification key.
Parameters
- partialIdentificationKey: string
  Partial identification key.
- OptionalpositionOffset: number
  Position offset within a larger string.
Returns void
Inherited from NonGTINNumericIdentificationKeyValidator.validatePrefix
- Defined in idkey.ts:317

Class SerializableNumericIdentificationKeyValidator

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns SerializableNumericIdentificationKeyValidator

Accessors

serialComponentLength

Returns number

serialComponentCharacterSet

Returns ContentCharacterSet

ProtectedserialComponentValidation

Returns CharacterSetValidation

serialComponentCreator

Returns CharacterSetCreator

leaderType

Returns LeaderType

Inherit Doc

identificationKeyType

Returns IdentificationKeyType

Inherit Doc

prefixType

Returns PrefixType

Inherit Doc

length

Returns number

Inherit Doc

referenceCharacterSet

Returns ContentCharacterSet

Inherit Doc

referenceCreator

Returns CharacterSetCreator

Inherit Doc

Methods

Protected StaticcreatorFor

Parameters

Returns CharacterSetCreator

validate

Parameters

Returns void

Inherit Doc

ProtectedpadIdentificationKey

Parameters

Returns string

ProtectedvalidatePrefix

Parameters

Returns void

Settings

On This Page

`Protected`serialComponentValidation

`Protected` `Static`creatorFor

`Protected`padIdentificationKey

`Protected`validatePrefix