Plucen...:Filter(3pm)

💖 NAME 💖

okay so bestie, welcome to Plucene::Search::Filter — it's the search filter base class ✨. That's the whole vibe. It's a base class, it's about filtering searches, and it's here to be subclassed by you. 🫶

This is a 3pm page, straight out of the User Contributed Perl Documentation, so you know it's the real deal.

---

🌸 DESCRIPTION 🌸

so like… ngl, this doesn't seem to be being used just yet 👀. But here's some info on filters anyway, because knowledge is free and you deserve it 💅:

Filtering means imposing additional restriction on the hit list to eliminate hits that otherwise would be included in the search results. It's giving bouncer at the club door 🚪✨ — if you don't match the criteria, you're not getting in.

There are two ways to filter hits:

• Search Query — in this approach, provide your custom filter object to the when you call the search() method. This filter will be called exactly once to evaluate every document that resulted in non zero score. one shot, one opportunity, no reruns 🎯
• Selective Collection — in this approach you perform the regular search and when you get back the hit list, collect only those that matches your filtering criteria. In this approach, your filter is called only for hits that returned by the search method which may be only a subset of the non zero matches (useful when evaluating your search filter is expensive). it's the low-effort, high-reward option fr fr 💅 — perfect when your filter costs a lot to run and you don't wanna waste it on hits that don't even matter 🦋

---

✨ METHODS ✨

🎀 bits

This must be defined in a subclass 🌈. Like, the base class is not gonna do it for you, bestie — you have to bring the bits. periodt 👑

---

a lil heads up: this page is running on perl v5.36.0, dated 2022-12-04, and it lives under Plucen...:Filter(3pm) in the User Contributed Perl Documentation. 💜

and that's the whole page, bestie!! go forth and subclass responsibly 🧚💖🌸