The eclecticse.slk-581 Reference Manual

This is the eclecticse.slk-581 Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 08 19:35:47 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 eclecticse.slk-581

Generate Australian Government SLK-581 codes.

Author

<>

License

LLGPL

Version

1.0.0

Dependency

cl-ppcre (system).

Source

eclecticse.slk-581.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 eclecticse.slk-581/eclecticse.slk-581.asd

Source

eclecticse.slk-581.asd.

Parent Component

eclecticse.slk-581 (system).

ASDF Systems

eclecticse.slk-581.


3.1.2 eclecticse.slk-581/package.lisp

Source

eclecticse.slk-581.asd.

Parent Component

eclecticse.slk-581 (system).

Packages

eclecticse.slk-581.


3.1.3 eclecticse.slk-581/data-rec.lisp

Dependency

package.lisp (file).

Source

eclecticse.slk-581.asd.

Parent Component

eclecticse.slk-581 (system).

Internals

3.1.4 eclecticse.slk-581/specials.lisp

Dependency

data-rec.lisp (file).

Source

eclecticse.slk-581.asd.

Parent Component

eclecticse.slk-581 (system).

Internals

3.1.5 eclecticse.slk-581/slk-581.lisp

Dependency

specials.lisp (file).

Source

eclecticse.slk-581.asd.

Parent Component

eclecticse.slk-581 (system).

Public Interface

4 Packages

Packages are listed by definition order.


4.1 eclecticse.slk-581

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Ordinary functions

Function: data-rec->slk-581 (data-rec)

Generate the SLK-581 code for DATA-REC.

Package

eclecticse.slk-581.

Source

slk-581.lisp.

Function: regex-check-slk-581 (slk-581)
Package

eclecticse.slk-581.

Source

slk-581.lisp.

Function: slk-581 (given-name family-name date-of-birth sex)

Return the SLK-581 code for the given data. DATE-OF-BIRTH is a string in YYYY-MM-DD (ISO 8601) format. Sex is one of the following values, which match Australian government
classification: :MALE, :FEMALE, :OTHER, :UNKNOWN, or the strings, ’Male’, ’Female’, ’Other’, ’Unknown’, ’Intersex’, or ’Indeterminate’. Unknown is the same a ’not stated’ or ’inadequately described’.

Package

eclecticse.slk-581.

Source

slk-581.lisp.

Function: test-slk-581 ()

Run tests against all test data records and report the results.

Package

eclecticse.slk-581.

Source

slk-581.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *slk-scanner*

Regular expression to validate structure of an SLK-581 code.

Package

eclecticse.slk-581.

Source

specials.lisp.

Special Variable: *test-data*

Test data with known correct SLK-581 values.

Package

eclecticse.slk-581.

Source

specials.lisp.


5.2.2 Ordinary functions

Function: cleanse-item (item)

Trim ITEM and convert to upper case if a string.

Package

eclecticse.slk-581.

Source

data-rec.lisp.

Function: cleanse-name (name)

Remove non-alpha characters from NAME.

Package

eclecticse.slk-581.

Source

data-rec.lisp.

Function: field-val (item)

Return the value of ITEM, which is a (key value) pair.

Package

eclecticse.slk-581.

Source

data-rec.lisp.

Function: get-dob (data-rec)

Retrieve the date of birth in ddmmyyyy format, from DATA-REC.

Package

eclecticse.slk-581.

Source

data-rec.lisp.

Function: get-first-name (data-rec)

Retrieve the cleansed first name from DATA-REC.

Package

eclecticse.slk-581.

Source

data-rec.lisp.

Function: get-first-name-letters (data-rec)

Retrieve the two letters of the first name which form part of the SLK code.

Package

eclecticse.slk-581.

Source

data-rec.lisp.

Function: get-item (which data-rec)

Retrieve a (key value) pair from the DATA-REC. WHICH is one of – :first-name :surname :gender :dob :slk

Package

eclecticse.slk-581.

Source

data-rec.lisp.

Function: get-sex-code (data-rec)

Retrieve the SLK sex/gender code for DATA-REC.

Package

eclecticse.slk-581.

Source

data-rec.lisp.

Function: get-surname (data-rec)

Retrieve the cleansed surname from DATA-REC.

Package

eclecticse.slk-581.

Source

data-rec.lisp.

Function: get-surname-letters (data-rec)

Retrieve the three letters of the surname which form part of the SLK code.

Package

eclecticse.slk-581.

Source

data-rec.lisp.

Function: iso-date->ddmmyyyy (iso-date)

Convert an ISO 8601 date with hyphens into DDMMYYYY.

Package

eclecticse.slk-581.

Source

data-rec.lisp.

Function: trim (string)

Remove spaces from start and end of STRING.

Package

eclecticse.slk-581.

Source

data-rec.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   C   D   F   G   I   R   S   T  
Index Entry  Section

C
cleanse-item: Private ordinary functions
cleanse-name: Private ordinary functions

D
data-rec->slk-581: Public ordinary functions

F
field-val: Private ordinary functions
Function, cleanse-item: Private ordinary functions
Function, cleanse-name: Private ordinary functions
Function, data-rec->slk-581: Public ordinary functions
Function, field-val: Private ordinary functions
Function, get-dob: Private ordinary functions
Function, get-first-name: Private ordinary functions
Function, get-first-name-letters: Private ordinary functions
Function, get-item: Private ordinary functions
Function, get-sex-code: Private ordinary functions
Function, get-surname: Private ordinary functions
Function, get-surname-letters: Private ordinary functions
Function, iso-date->ddmmyyyy: Private ordinary functions
Function, regex-check-slk-581: Public ordinary functions
Function, slk-581: Public ordinary functions
Function, test-slk-581: Public ordinary functions
Function, trim: Private ordinary functions

G
get-dob: Private ordinary functions
get-first-name: Private ordinary functions
get-first-name-letters: Private ordinary functions
get-item: Private ordinary functions
get-sex-code: Private ordinary functions
get-surname: Private ordinary functions
get-surname-letters: Private ordinary functions

I
iso-date->ddmmyyyy: Private ordinary functions

R
regex-check-slk-581: Public ordinary functions

S
slk-581: Public ordinary functions

T
test-slk-581: Public ordinary functions
trim: Private ordinary functions