STAR::Filter(3pm)

💖 STAR::Filter 💖

okay bestie, welcome to STAR::Filter from the STAR perl module crew — it's literally a Perl extension for filtering DataBlock objects. that's the whole vibe.

Version check: this doc is talking about version 0.01 of the module. yes, baby version, we love an early era icon. ✨

---

✨ SYNOPSIS ✨

use STAR::Filter;

that's it. that's the whole summoning ritual. 🕯️

---

🌸 DESCRIPTION 🌸

so basically: this module holds the filter object, and its whole job is filtering DataBlock objects. where do those come from? DataBlock objects get created by Parser and then modified by DataBlock. so it's a little pipeline, bestie — parser makes 'em, datablock tweaks 'em, filter filters 'em. 💅

---

👑 CLASS METHODS 👑

🎀 filter_dict

Usage:  $filtered_dict = STAR::Filter->filter_dict(
                           -dict=>$dict,
                           -options=>$options);

a (very simplistic) interactive method for filtering a STAR::Dictionary object (you know, the .cob file 👀). it literally prompts the user for every single category and asks whether to include (retain) it in the filtered object. then it hands you back a reference to the filtered (reduced) STAR::Dictionary object. slay.

heads up bestie: this method is preliminary and subject to change. so don't get too attached to its exact behaviour, it's still in its glow-up era. 😭

🦋 filter_through_dict

Usage:  $filtered_data = STAR::Filter->filter_through_dict(
                           -data=>$data,
                           -dict=>$dict,
                           -options=>$options);

this one filters a STAR::DataBlock object through a STAR::Dictionary object. it returns a reference to a brand new STAR::DataBlock object, and the only stuff that makes it into that new object is the items that were defined in the specified dictionary. everything else? not invited to the party. 🙈

---

💜 AUTHOR 💜

Wolfgang Bluhm, mail@wbluhm.com — absolute legend, main character energy, fr fr. 🌟

Acknowledgments

big ups and thank-yous to Phil Bourne, Helge Weissig, Anne Kuller, Doug Greer, Michele Bluhm, and others for support, help, and comments. the group chat really came through. 🫶

---

⭐ COPYRIGHT ⭐

a full copyright statement is provided with the distribution, and here's the line that matters:

Copyright (c) 2000 University of California, San Diego

periodt. 💅

---

🌈 SEE ALSO 🌈

• STAR::Parser
• STAR::DataBlock
• STAR::Dictionary

go read those too, iykyk. they're the rest of the squad. 👑

---

and that's a wrap on this lil doc, which was baked with perl v5.18.1 and dated 2001-05-22, filed under STAR::Filter(3pm). nostalgic iconic behavior honestly. stay filtered, bestie 💖✨🎀