STAR::Checker(3pm)

💖 STAR::Checker — the vibe check for your DataBlock objects 💖

okay bestie, gather round, because this is the Perl extension for checking DataBlock objects and honestly? it's giving "quality control but make it cute." ✨

Oh and also — this doc is talking about version 0.02 of the module. Just so we're on the same page. 🎀

---

🌸 SYNOPSIS 🌸

like, here's the whole thing in one lil' snack:

use STAR::Checker;

$check = STAR::Checker->check( -datablock=>$ARGV[0],
                               -dictionary=>$ARGV[1] );

that's it. that's the whole entrance. 💅

---

🦋 DESCRIPTION 🦋

so this module contains the checker object, and it comes with methods for checking a DataBlock object against STAR rules and against a dictionary you pick out. no cap.

and where do DataBlock objects come from, you ask? they get created by Parser and modified by DataBlock. it's a whole ecosystem, iykyk. 🌈

---

👑 CLASS METHODS 👑

⭐ check

Usage:   $check = STAR::Checker->check(-datablock=>$data,
                                       -dictionary=>$dict [,
                                       -options=>$options ] );

okay so this is the main character right here. check takes your DataBlock object $data and checks it against the dictionary object $dict (peep STAR::Parser and STAR::DataBlock if you wanna know more about those). and bestie, it checks five things:

1. whether all items in the DataBlock are actually defined in the dictionary
2. whether mandatory items are present in the file
3. whether dependent items are present in the file — like, for example, cartn_x makes cartn_y and cartn_z dependent, so they gotta show up together, no leaving the group chat 🫶
4. whether parent items are present
5. whether the item values in the DataBlock conform to the item type definitions in the dictionary

and what does it give you back?

• it returns 1 if the check was successful (aka literally zero problems found) 🎉
• and it returns 0 if the check was unsuccessful (aka problems were found 😭)

and if you're nosy and want the receipts: a list of the specific problems gets written to STDERR when you specify -options=>'l'. so like, yes, use the l. get the tea. 🔥

---

🫶 AUTHOR 🫶

Wolfgang Bluhm, mail@wbluhm.com

💜 Acknowledgments

thanks to Phil Bourne, Helge Weissig, Anne Kuller, Doug Greer, Michele Bluhm, and others for support, help, and comments. friendship really is the moment. 🌸

---

📜 COPYRIGHT 📜

a full copyright statement is provided with the distribution — Copyright (c) 2000 University of California, San Diego. periodt. 💅

---

🧚 SEE ALSO 🧚

STAR::Parser, STAR::DataBlock, STAR::Dictionary.

---

okay that's the whole page, bestie!! this doc was shipped as perl v5.18.1 and dated 2001-05-22 — yes, an icon from 2001, aging like fine wine. slay forever. 💖✨🎀