Solr: tworzenie własnego filtra

Rafał Kuć Solr , , , , 0 Comment

Czasami to co oferują Lucene i Solr mogą okazać się niewystarczające. Wtedy musimy sami rozszerzyć możliwości w/w i przygotować kawałek własnego kodu. W dzisiejszym wpisie postaram się pokazać, jak przygotować własny filtr i jak użyć go w Solr.

Wersja Solr

Poniższy tutorial dotyczy Solr 3.6. Uaktualniona wersja tego tutoriala pojawi się w momencie premiery Solr 4.0.

Założenia

Na potrzeby tego wpisu załóżmy, iż potrzebujemy filtra, który umożliwi nam odwrócenie dowolnego napisu. Zatem, jeżeli na wejściu dostajemy napis „solr.pl”, to na wyjściu chcemy otrzymać „lp.rlos”. Nie jest to może najtrudniejszy przykład funkcjonalności, ale na potrzeby wpisu wystarczy. We wpisie pomijam kwestie przygotowania sobie środowiska, kompilacji kodu, budowania biblioteki i tym podobnych.

Informacja dodatkowa

Kod, który będzie pokazany został stworzony, aby mógł działać w oparciu o Solr w wersji 3.6, ale nie powinno być problemów, aby został wykorzystany z Solr 4, aczkolwiek może być konieczna lekka modyfikacja kodu (jeżeli zmieni się coś w przyszłości w chwili wypuszczenia Solr).

Czego potrzebujemy

Aby nasz filtr mógł zostać wykorzystany w Solr potrzebujemy dwóch klas. Po pierwsze potrzebujemy implementacji właściwego filtra, która będzie realizować właściwą funkcjonalność. Po drugie konieczna będzie implementacji fabryki filtrów, która będzie odpowiedzialna za tworzenie i inicjalizację naszych filtrów. Zatem do dzieła.

Filtr

Aby zaimplementować nasz filtr skorzystamy z klasy TokenFilter z pakietu org.apache.lucene.analysis i rozszerzymy ją nadpisując metodę incrementToken. Metoda ta zwraca wartość typu boolean. Założenie jest takie, że jeżeli w strumieniu jest jeszcze token do dalszego przetwarzania metoda powinna zwrócić wartość true, jeżeli natomiast nie zostało już nic do przetworzenia metoda zwraca false. Implementacja filtra mogłaby wyglądać następująco: 

package pl.solr.analysis;

import java.io.IOException;

import org.apache.lucene.analysis.TokenFilter;
import org.apache.lucene.analysis.TokenStream;
import org.apache.lucene.analysis.tokenattributes.CharTermAttribute;

public final class ReverseFilter extends TokenFilter {
  private CharTermAttribute charTermAttr;

  protected ReverseFilter(TokenStream ts) {
    super(ts);
    this.charTermAttr = addAttribute(CharTermAttribute.class);
  }

  @Override
  public boolean incrementToken() throws IOException {
    if (!input.incrementToken()) {
      return false;
    }

    int length = charTermAttr.length();
    char[] buffer = charTermAttr.buffer();
    char[] newBuffer = new char[length];
    for (int i = 0; i < length; i++) {
      newBuffer[i] = buffer[length - 1 - i];
    }
    charTermAttr.setEmpty();
    charTermAttr.copyBuffer(newBuffer, 0, newBuffer.length);
    return true;
  }
}

Wyjaśnienia niektórych elementów implementacji

Kilka słów wyjaśnienia, do implementacji pokazanej powyżej:

  • Linia 9 – klasa, która rozszerza klasę TokenFilter powinna być oznaczona jako final (wymagania stawiane przez Lucene).
  • Linia 10 – atrybut strumienia tokenów, który umożliwia pobranie oraz modyfikację tekstu z jakiego składa się dany term. Nasz filtr jest w stanie wykorzystywać wiele atrybutów strumienia, np. pozycję tokena w strumieniu, czy payload’ami. Listę klas implementujących interfejs Attribute można znaleźć w dokumentacji API Lucene (np. http://lucene.apache.org/core/3_6_0/api/all/org/apache/lucene/util/Attribute.html).
  • Linie 12 – 15 – konstruktor przyjmujący jako argument strumień tokenów oraz dodający (linia 14) do naszego filtra odpowiedni atrybut strumienia tokenów.
  • Linie 18 – 30 – implementacja metody incrementToken realizującej właściwe odwracanie napisów.
  • Linie 19 – 21 – sprawdzenie, czy został jakiś token w strumieniu i jeżeli nie został, to zwrócenie wartości false.
  • Linia 23 – pobranie właściwej wielkości bufora, którego zawartość to napis, który chcemy odwrócić.
  • Linia 24 – pobranie bufora, którego zawartość to napis który chcemy odwrócić. Tekst termu przechowywany jest jako tablica typu char i dlatego najbardziej wydajnym rozwiązaniem jest właśnie operacja na tej tablicy, a nie na obiekcie typu String.
  • Linie 25 – 28 – stworzenie nowego bufora oraz odwracanie aktualnego.
  • Linia 29 – oczyszczenie oryginalnego bufora (konieczne w przypadku korzystania z metod append).
  • Linia 30 – skopiowanie zmian z powrotem do bufora, czyli tak naprawdę zamienienie tego, który pobraliśmy w linii 23, na ten, który został już przetworzony.
  • Linia 31 – zwrócenie wartości true, aby poinformować, iż w buforze jest token do dalszego przetwarzania.

Fabryka

Tak jak wspomniałem wcześniej, aby móc skorzystać z naszego, wyżej zaimplementowanego filtra, konieczna jest implementacja fabryki. Ze względu na to, że nie mamy żadnych specjalnych opcji konfiguracyjnych, sama implementacja będzie dość prosta i zostanie oparta o klasę BaseTokenFilterFactory z pakietu org.apache.solr.analysis. Sama implementacja mogłaby wyglądać następująco: 

package pl.solr.analysis;

import org.apache.lucene.analysis.TokenStream;
import org.apache.solr.analysis.BaseTokenFilterFactory;

public class ReverseFilterFactory extends BaseTokenFilterFactory {
  @Override
  public TokenStream create(TokenStream ts) {
    return new ReverseFilter(ts);
  }
}

Jak widać sama implementacja jest prosta i wymaga od nas nadpisania metody create w której tworzymy nasz filtr i zwracamy go. Nic bardziej prostego.

Konfiguracja

Po skompilowaniu i przygotowaniu biblioteki w formacie jar, kopiujemy ją do katalogu, gdzie Solr będzie ją widział. Możemy to uzyskać np. tworząc katalog lib w katalogu domowym Solr, a następnie dodać odpowiedni wpis do pliku solrconfig.xml, np. taki: 

<lib dir="../lib/" regex="*.jar" />

Następnie zmieniamy plik schema.xml dodając nasz filtr do jednego z typów, na przykład w następujący sposób: 

<fieldType name="text_reversed" class="solr.TextField">
  <analyzer>
    <tokenizer class="solr.WhitespaceTokenizerFactory"/>
    <filter class="pl.solr.analysis.ReverseFilterFactory" />
  </analyzer>
</fieldType>

Warto zauważyć, iż w w atrybucie class znacznika filter podajemy pełną nazwę pakietu oraz nazwę klasy implementującej fabrykę, a nie implementującą filtr. To ważne, inaczej Solr nie będzie w stanie stworzyć filtra.

Działanie

Poniżej zrzut ekranu z panelu administracyjnego Solr ilustrujący działanie filtra:

Podsumowanie

Jak widać na powyższym przykładzie, implementacja własnego filtra nie jest rzeczą bardzo skomplikowaną. Oczywiście, po raz kolejny podkreślę, iż pokazany przykład jest bardzo prosty, dlatego też sama implementacja należy do prostych. Mam nadzieję, iż po przeczytaniu tego artykułu tworzenie własnych filtrów do Solr będzie łatwiejsze 🙂

Dodaj komentarz

Twój adres email nie zostanie opublikowany. Wymagane pola są oznaczone *

We use cookies to personalise content and ads, to provide social media features and to analyse our traffic. We also share information about your use of our site with our social media, advertising and analytics partners.
Cookies settings
Accept
Privacy & Cookie policy
Privacy & Cookies policy
Cookies list
Cookie name Active

Privacy Policy

What information do we collect?

We collect information from you when you register on our site or place an order. When ordering or registering on our site, as appropriate, you may be asked to enter your: name, e-mail address or mailing address.

What do we use your information for?

Any of the information we collect from you may be used in one of the following ways: To personalize your experience (your information helps us to better respond to your individual needs) To improve our website (we continually strive to improve our website offerings based on the information and feedback we receive from you) To improve customer service (your information helps us to more effectively respond to your customer service requests and support needs) To process transactions Your information, whether public or private, will not be sold, exchanged, transferred, or given to any other company for any reason whatsoever, without your consent, other than for the express purpose of delivering the purchased product or service requested. To administer a contest, promotion, survey or other site feature To send periodic emails The email address you provide for order processing, will only be used to send you information and updates pertaining to your order.

How do we protect your information?

We implement a variety of security measures to maintain the safety of your personal information when you place an order or enter, submit, or access your personal information. We offer the use of a secure server. All supplied sensitive/credit information is transmitted via Secure Socket Layer (SSL) technology and then encrypted into our Payment gateway providers database only to be accessible by those authorized with special access rights to such systems, and are required to?keep the information confidential. After a transaction, your private information (credit cards, social security numbers, financials, etc.) will not be kept on file for more than 60 days.

Do we use cookies?

Yes (Cookies are small files that a site or its service provider transfers to your computers hard drive through your Web browser (if you allow) that enables the sites or service providers systems to recognize your browser and capture and remember certain information We use cookies to help us remember and process the items in your shopping cart, understand and save your preferences for future visits, keep track of advertisements and compile aggregate data about site traffic and site interaction so that we can offer better site experiences and tools in the future. We may contract with third-party service providers to assist us in better understanding our site visitors. These service providers are not permitted to use the information collected on our behalf except to help us conduct and improve our business. If you prefer, you can choose to have your computer warn you each time a cookie is being sent, or you can choose to turn off all cookies via your browser settings. Like most websites, if you turn your cookies off, some of our services may not function properly. However, you can still place orders by contacting customer service. Google Analytics We use Google Analytics on our sites for anonymous reporting of site usage and for advertising on the site. If you would like to opt-out of Google Analytics monitoring your behaviour on our sites please use this link (https://tools.google.com/dlpage/gaoptout/)

Do we disclose any information to outside parties?

We do not sell, trade, or otherwise transfer to outside parties your personally identifiable information. This does not include trusted third parties who assist us in operating our website, conducting our business, or servicing you, so long as those parties agree to keep this information confidential. We may also release your information when we believe release is appropriate to comply with the law, enforce our site policies, or protect ours or others rights, property, or safety. However, non-personally identifiable visitor information may be provided to other parties for marketing, advertising, or other uses.

Registration

The minimum information we need to register you is your name, email address and a password. We will ask you more questions for different services, including sales promotions. Unless we say otherwise, you have to answer all the registration questions. We may also ask some other, voluntary questions during registration for certain services (for example, professional networks) so we can gain a clearer understanding of who you are. This also allows us to personalise services for you. To assist us in our marketing, in addition to the data that you provide to us if you register, we may also obtain data from trusted third parties to help us understand what you might be interested in. This ‘profiling’ information is produced from a variety of sources, including publicly available data (such as the electoral roll) or from sources such as surveys and polls where you have given your permission for your data to be shared. You can choose not to have such data shared with the Guardian from these sources by logging into your account and changing the settings in the privacy section. After you have registered, and with your permission, we may send you emails we think may interest you. Newsletters may be personalised based on what you have been reading on theguardian.com. At any time you can decide not to receive these emails and will be able to ‘unsubscribe’. Logging in using social networking credentials If you log-in to our sites using a Facebook log-in, you are granting permission to Facebook to share your user details with us. This will include your name, email address, date of birth and location which will then be used to form a Guardian identity. You can also use your picture from Facebook as part of your profile. This will also allow us and Facebook to share your, networks, user ID and any other information you choose to share according to your Facebook account settings. If you remove the Guardian app from your Facebook settings, we will no longer have access to this information. If you log-in to our sites using a Google log-in, you grant permission to Google to share your user details with us. This will include your name, email address, date of birth, sex and location which we will then use to form a Guardian identity. You may use your picture from Google as part of your profile. This also allows us to share your networks, user ID and any other information you choose to share according to your Google account settings. If you remove the Guardian from your Google settings, we will no longer have access to this information. If you log-in to our sites using a twitter log-in, we receive your avatar (the small picture that appears next to your tweets) and twitter username.

Children’s Online Privacy Protection Act Compliance

We are in compliance with the requirements of COPPA (Childrens Online Privacy Protection Act), we do not collect any information from anyone under 13 years of age. Our website, products and services are all directed to people who are at least 13 years old or older.

Updating your personal information

We offer a ‘My details’ page (also known as Dashboard), where you can update your personal information at any time, and change your marketing preferences. You can get to this page from most pages on the site – simply click on the ‘My details’ link at the top of the screen when you are signed in.

Online Privacy Policy Only

This online privacy policy applies only to information collected through our website and not to information collected offline.

Your Consent

By using our site, you consent to our privacy policy.

Changes to our Privacy Policy

If we decide to change our privacy policy, we will post those changes on this page.
Save settings
Cookies settings