Crossing References Check

Cross references are EUI used as references among lexical records. They are used in Abbreviations, Acronyms, and Nominalizations. A series of programs are developed to check cross references. This is called in post-process stage to ensure the quality of LEXICON. The design details are described as follows:

• The following steps are performed by clicking the Identify button:
  • I. Generate the latest LEXICON

  • II. Generate file: acrAbbNom.data
    • Java file: GenerateAcrAbbNomRecords.java
      Go through all lexical records (from file: LEXICON) to print out all information for Abbreviations, Acronyms, and Nominalizations.
    • File format:
      

      Field 1	Field 2	Field 3	Field 4	Fields 5, 6, 7
      base	base cat	base EUI	ACR	acronym acronym|acronym EUI
      base	base cat	base EUI	ABB	abbreviation abbreviation|abbreviation EUI
      base	base cat	base EUI	NOM	nominalization nominalization|nominalization cat nominalization|nominalization cat|nominalization EUI

  • III. Check and tag cross reference on acrAbbNom.data
    • Java file: CheckCrossRef.java
    • Go through every single line in acrAbbNom.data
    • Send results to following five files:
      • newTerm.data
        This file lists all terms (base|cat) are used in ABB/ACR/NOM but does not has a lexical record. These new term should be added to LEXICON to complete the cross references. Ideally, this file should contain no lines.

        Type	Condition	Source	ABB/ACR/NOM	Base	Category
        acr/abb	No EUIs	line	ABB/ACR	base	cat
        nom	No EUIs	line	NOM	base	cat

      • dup.data
        This file lists all terms (base|cat) are used in ABB/ACR/NOM with multiple EUIs. They could be duplicated lexical records and should be consolidated. An exceptions filter should be used for those false-positive cases.

        Type	Condition	Source	ABB/ACR/NOM	Base	Category	Suggested EUIs
        acr/abb	Same base/sp_vars (case sensitive) Same category Multiple EUIs	line	ABB/ACR	base	cat	EUIs
        nom	Same base/sp_vars (case sensitive) Same category Multiple EUIs	line	NOM	base	cat	EUIs

        Notes: records in dup.data needs to add to dupExceptionList if they are not duplicated.

      • acr.data & abb.data:
        These two files are in the same format to list all found problems on ACR/ABB from acrAbbNom.data.

        Case ID	Condition	Source	Issue Types	Msg Types	Source Line No	Suggested EUIs	Notes
        1	field num < 5	line	NO BASE FIELD	ERROR	recNum		Fix - add base field
        2	field num = 5	line	NO EUI FIELD	WARNING	recNum	Suggested EUI	Fix - add EUI field (auto)
        3	field num = 5	line	NO EUIS FIELD	WARNING	recNum	Suggested EUIs	Fix - add EUI field (choose one)
        4	field num = 6 No record found	line	NO REC FOUND	WARNING	recNum	Empty EUI	Fix - modify lexRecord
        5	field num = 6 No EUI found	line	NO EUI FOUND	WARNING	recNum	Empty EUI	Fix - modify lexRecord
        6	field num = 6 Different EUI found	line	WRONG EUI	ERROR	recNum	Suggested EUI	Fix - change EUI (auto)
        7	field num = 6 EUIs does not contain EUI	line	WRONG EUIS	ERROR	recNum	Suggested EUIs	Fix - choose EUI
        8	field num = 6 EUIs contains EUI	line	CHECK EUI	WARNING	recNum	Suggested EUIs	Check - add to exceptions dupException.data: if not duplicated abb/acrException.data: the right choice
        9	field num = 6 EUI is null	line	EUI NULL	ERROR	recNum	Suggested EUIs	Fix - modify lexRecord

      • nom.data
        This file list all found problem on NOM from acrAbbNom.data

        Case ID	Condition	Source	Issue Types	Msg Types	Source Line No	Suggested cats	Suggested EUIs	Notes
        1	field num < 5	line	NO BASE FIELD	ERROR	recNum			Fix - add base field
        2	field num = 5	line	NO CAT FIELD	ERROR	recNum	Suggested cat	Suggested EUIs	Fix - add cat|EUI fields
        3	field num = 6	line	NO EUI FIELD	WARNING	recNum	cat	Suggested EUI	Fix - add EUI field (auto)
        4	field num = 6	line	NO EUIS FIELD	WARNING	recNum	cat	Suggested EUIs	Fix - add EUI field (choose one)
        5	field num = 7 No record found	line	NO REC FOUND	WARNING	recNum	cat	Empty EUI	Fix - modify lexRecord
        6	field num = 7 No EUI found	line	NO EUI FOUND	WARNING	recNum	cat	Empty EUI	Fix - modify lexRecord
        7	field num = 7 Different cat	line	WRONG CAT	WARNING	recNum	Suggested cat	Suggested EUIs	Fix - modify lexRecord
        8	field num = 7 Cats does not contain cat	line	WRONG CATS	WARNING	recNum	Suggested cat	Suggested EUIs	Fix - modify lexRecord
        9	field num = 7 Cats contains cat	line	CHECK CAT	WARNING	recNum	Suggested cat	Suggested EUIs	Check - add to filter list
        10	field num = 7 Cat is null	line	CAT NULL	ERROR	recNum	Suggested cats	Suggested EUIs	Fix - modify lexRecord
        11	field num = 7 Different EUI found	line	WRONG EUI	ERROR	recNum	cat	Suggested EUI	Fix - change EUI (auto)
        12	field num = 7 EUIs does not contain EUI	line	WRONG EUIs	ERROR	recNum	cat	Suggested EUIs	Fix - choose EUI
        13	field num = 7 EUIs contains EUI	line	CHECK EUI	WARNING	recNum	cat	Suggested EUIs	Check - add to filter list
        14	field num = 7 EUI = null	line	EUI NULL	ERROR	recNum	cat	Suggested EUIs	Fix - modify lexRecord
        15	field num = 7 Not symmetric	line	NOT SYM	WARNING	recNum			Fix - modify lexRecord