diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a7baab0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +# Project exclude paths +/.gradle/ +/build/ diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..73f69e0 --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,8 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Datasource local storage ignored files +/dataSources/ +/dataSources.local.xml +# Editor-based HTTP Client requests +/httpRequests/ diff --git a/.idea/codeStyles/codeStyleConfig.xml b/.idea/codeStyles/codeStyleConfig.xml new file mode 100644 index 0000000..a55e7a1 --- /dev/null +++ b/.idea/codeStyles/codeStyleConfig.xml @@ -0,0 +1,5 @@ + + + + \ No newline at end of file diff --git a/.idea/compiler.xml b/.idea/compiler.xml new file mode 100644 index 0000000..61a9130 --- /dev/null +++ b/.idea/compiler.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/.idea/copyright/gpl3.xml b/.idea/copyright/gpl3.xml new file mode 100644 index 0000000..70069ed --- /dev/null +++ b/.idea/copyright/gpl3.xml @@ -0,0 +1,6 @@ + + + + \ No newline at end of file diff --git a/.idea/copyright/profiles_settings.xml b/.idea/copyright/profiles_settings.xml new file mode 100644 index 0000000..61abeb9 --- /dev/null +++ b/.idea/copyright/profiles_settings.xml @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/.idea/elasticsearch-analysis-raudikko.iml b/.idea/elasticsearch-analysis-raudikko.iml new file mode 100644 index 0000000..8865da7 --- /dev/null +++ b/.idea/elasticsearch-analysis-raudikko.iml @@ -0,0 +1,2 @@ + + \ No newline at end of file diff --git a/.idea/gradle.xml b/.idea/gradle.xml new file mode 100644 index 0000000..528f38c --- /dev/null +++ b/.idea/gradle.xml @@ -0,0 +1,20 @@ + + + + + + + \ No newline at end of file diff --git a/.idea/jarRepositories.xml b/.idea/jarRepositories.xml new file mode 100644 index 0000000..a05d546 --- /dev/null +++ b/.idea/jarRepositories.xml @@ -0,0 +1,30 @@ + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml new file mode 100644 index 0000000..2d29d6b --- /dev/null +++ b/.idea/misc.xml @@ -0,0 +1,10 @@ + + + + + + + + + + \ No newline at end of file diff --git a/.idea/modules/elasticsearch-analysis-raudikko.iml b/.idea/modules/elasticsearch-analysis-raudikko.iml new file mode 100644 index 0000000..d67ab22 --- /dev/null +++ b/.idea/modules/elasticsearch-analysis-raudikko.iml @@ -0,0 +1,2 @@ + + \ No newline at end of file diff --git a/.idea/modules/elasticsearch-analysis-raudikko.main.iml b/.idea/modules/elasticsearch-analysis-raudikko.main.iml new file mode 100644 index 0000000..1f1bfdb --- /dev/null +++ b/.idea/modules/elasticsearch-analysis-raudikko.main.iml @@ -0,0 +1,13 @@ + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/modules/elasticsearch-analysis-raudikko.test.iml b/.idea/modules/elasticsearch-analysis-raudikko.test.iml new file mode 100644 index 0000000..c982102 --- /dev/null +++ b/.idea/modules/elasticsearch-analysis-raudikko.test.iml @@ -0,0 +1,16 @@ + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..94a25f7 --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..37fcf1d --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,3 @@ +## 0.6.0 (2021-XX-XX) + + - Initial revision. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..a04828a --- /dev/null +++ b/README.md @@ -0,0 +1,90 @@ +# Raudikko Analysis for Elasticsearch + +The Raudikko Analysis plugin provides Finnish language analysis using [Raudikko](https://github.com/EvidentSolutions/raudikko). + +## Supported versions + +| Plugin version | Raudikko version | Elasticsearch version | +| -------------- | ---------------- | ----------------------| +| [0.1](https://github.com/EvidentSolutions/elasticsearch-analysis-raudikko/blob/v0.1.0/README.md) | 0.1.1 | 7.3.2 | + +If you are not installing the latest version, follow the links in the table to see installation instructions for the old version. + +## Installing + +To install the plugin, run: + +``` +bin/elasticsearch-plugin install https://github.com/EvidentSolutions/elasticsearch-analysis-raudikko/releases/download/v0.1/elasticsearch-analysis-raudikko-0.1.zip +``` + +### Verify installation + +After installing the plugin, you can quickly verify that it works by executing: + +``` +curl -XGET 'localhost:9200/_analyze' -H 'Content-Type: application/json' -d ' +{ + "tokenizer" : "finnish", + "filter" : [{"type": "raudikko"}], + "text" : "Testataan raudikon analyysiä tällä tavalla yksinkertaisesti." +}' +``` + +If this works without error messages, you can proceed to configure the plugin index. + +## Configuring + +Include `finnish` tokenizer and `raudikko` filter in your analyzer, for example: + +```json +{ + "index": { + "analysis": { + "analyzer": { + "default": { + "tokenizer": "finnish", + "filter": ["lowercase", "raudikkoFilter"] + } + }, + "filter": { + "raudikkoFilter": { + "type": "raudikko" + } + } + } + } +} +``` + +You can use the following filter options to customize the behaviour of the filter: + +| Parameter | Default value | Description | +|-------------------|------------------|--------------------------------------------------| +| analyzeAll | true | Use all analysis possibilities or just the first | +| minimumWordSize | 3 | minimum length of words to analyze | +| maximumWordSize | 100 | maximum length of words to analyze | +| analysisCacheSize | 1024 | number of analysis results to cache | + +## Compatibility with elasticsearch-analysis-voikko + +This plugin supercedes [elasticsearch-analysis-voikko](https://github.com/EvidentSolutions/elasticsearch-analysis-voikko) and +is fully compatible with it (it provides a filter named `voikko` as a compatibility measure). Therefore, you can remove +the old plugin from your Elasticsearch installation and replace it with this plugin without having to reindex anything. + +## License and copyright + +Copyright (C) 2021 Evident Solutions Oy + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..65b9455 --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,53 @@ +plugins { + `java-library` +} + +group = "fi.evident.elasticsearch" +version = "0.1" + +repositories { + mavenCentral() +} + +val elasticsearchVersion = "7.3.2" + +dependencies { + compileOnly("org.elasticsearch:elasticsearch:$elasticsearchVersion") + implementation("fi.evident.raudikko:raudikko:0.1.1") + + testImplementation("org.elasticsearch:elasticsearch:$elasticsearchVersion") + testImplementation(platform("org.junit:junit-bom:5.7.0")) + testImplementation("org.junit.jupiter:junit-jupiter") +} + +tasks.withType { + options.encoding = "UTF-8" +} + +tasks.test { + useJUnitPlatform() +} + +val distributionZip = tasks.register("distributionZip") { + archiveBaseName.set("elasticsearch-analysis-raudikko") + from(file("src/main/plugin-metadata")) { + expand( + "pluginVersion" to project.version, + "javaVersion" to System.getProperty("java.specification.version"), + "elasticsearchVersion" to elasticsearchVersion + ) + } + from(tasks.jar) + from(configurations.runtimeClasspath) +} + +artifacts { + add(configurations.archives.name, distributionZip) +} + +java { + toolchain { + languageVersion.set(JavaLanguageVersion.of(8)) + vendor.set(JvmVendorSpec.ADOPTOPENJDK) + } +} diff --git a/etc/test-analyzer.http b/etc/test-analyzer.http new file mode 100644 index 0000000..ef58c35 --- /dev/null +++ b/etc/test-analyzer.http @@ -0,0 +1,8 @@ +GET localhost:9200/_analyze +Content-Type: application/json; charset=UTF-8 + +{ + "tokenizer" : "finnish", + "filter" : ["raudikko"], + "text" : "Testataan raudikon analyysiä tällä tavalla yksinkertaisesti." +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..e708b1c Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..da9702f --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-6.8-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..4f906e0 --- /dev/null +++ b/gradlew @@ -0,0 +1,185 @@ +#!/usr/bin/env sh + +# +# Copyright 2015 the original author or authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin or MSYS, switch paths to Windows format before running java +if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=`expr $i + 1` + done + case $i in + 0) set -- ;; + 1) set -- "$args0" ;; + 2) set -- "$args0" "$args1" ;; + 3) set -- "$args0" "$args1" "$args2" ;; + 4) set -- "$args0" "$args1" "$args2" "$args3" ;; + 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=`save "$@"` + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..107acd3 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..4cc8f57 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,2 @@ +rootProject.name = "elasticsearch-analysis-raudikko" + diff --git a/src/main/java/fi/evident/elasticsearch/raudikko/analysis/AnalysisCache.java b/src/main/java/fi/evident/elasticsearch/raudikko/analysis/AnalysisCache.java new file mode 100644 index 0000000..74082da --- /dev/null +++ b/src/main/java/fi/evident/elasticsearch/raudikko/analysis/AnalysisCache.java @@ -0,0 +1,52 @@ +/* + * Copyright (C) 2021 Evident Solutions Oy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package fi.evident.elasticsearch.raudikko.analysis; + +import java.util.List; +import java.util.concurrent.locks.ReentrantLock; + +final class AnalysisCache { + + private final LRUCache> cache; + private final ReentrantLock lock = new ReentrantLock(true); + + AnalysisCache(int cacheSize) { + cache = new LRUCache<>(cacheSize); + } + + List get(String word) { + // Note that it seems that we could use a read/write -lock here and grab only the read-lock + // when retrieving stuff from cache, but this will not work because the cache uses access-order, + // meaning that every read will actually mutate the cache. + lock.lock(); + try { + return cache.get(word); + } finally { + lock.unlock(); + } + } + + void put(String word, List result) { + lock.lock(); + try { + cache.put(word, result); + } finally { + lock.unlock(); + } + } +} diff --git a/src/main/java/fi/evident/elasticsearch/raudikko/analysis/FinnishTokenizer.java b/src/main/java/fi/evident/elasticsearch/raudikko/analysis/FinnishTokenizer.java new file mode 100644 index 0000000..d22240e --- /dev/null +++ b/src/main/java/fi/evident/elasticsearch/raudikko/analysis/FinnishTokenizer.java @@ -0,0 +1,33 @@ +/* + * Copyright (C) 2021 Evident Solutions Oy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package fi.evident.elasticsearch.raudikko.analysis; + +import org.apache.lucene.analysis.util.CharTokenizer; + +/** + * A tokenizer that tries to break text into tokens based on rules of Finnish language. + * This is almost same as {@link org.apache.lucene.analysis.core.LetterTokenizer}, but + * treats hyphen as a letter as well, since hyphens can be part of words. (e.g. "rippi-isä"). + */ +class FinnishTokenizer extends CharTokenizer { + + @Override + protected boolean isTokenChar(int c) { + return Character.isLetterOrDigit(c) || c == '-'; + } +} diff --git a/src/main/java/fi/evident/elasticsearch/raudikko/analysis/FinnishTokenizerFactory.java b/src/main/java/fi/evident/elasticsearch/raudikko/analysis/FinnishTokenizerFactory.java new file mode 100644 index 0000000..2274806 --- /dev/null +++ b/src/main/java/fi/evident/elasticsearch/raudikko/analysis/FinnishTokenizerFactory.java @@ -0,0 +1,42 @@ +/* + * Copyright (C) 2021 Evident Solutions Oy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package fi.evident.elasticsearch.raudikko.analysis; + +import org.apache.lucene.analysis.Tokenizer; +import org.elasticsearch.common.settings.Settings; +import org.elasticsearch.env.Environment; +import org.elasticsearch.index.IndexSettings; +import org.elasticsearch.index.analysis.AbstractTokenizerFactory; + +/** + * Factory that creates {@link FinnishTokenizer}. + */ +public class FinnishTokenizerFactory extends AbstractTokenizerFactory { + + public FinnishTokenizerFactory(IndexSettings indexSettings, + @SuppressWarnings("unused") Environment environment, + @SuppressWarnings("unused") String name, // TODO do we need name somewhere? + Settings settings) { + super(indexSettings, settings); + } + + @Override + public Tokenizer create() { + return new FinnishTokenizer(); + } +} diff --git a/src/main/java/fi/evident/elasticsearch/raudikko/analysis/LRUCache.java b/src/main/java/fi/evident/elasticsearch/raudikko/analysis/LRUCache.java new file mode 100644 index 0000000..c67a7ec --- /dev/null +++ b/src/main/java/fi/evident/elasticsearch/raudikko/analysis/LRUCache.java @@ -0,0 +1,41 @@ +/* + * Copyright (C) 2021 Evident Solutions Oy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + + +package fi.evident.elasticsearch.raudikko.analysis; + +import java.util.LinkedHashMap; +import java.util.Map; + +/** + * A bounded cache that evicts least recently used items when it becomes full. + */ +final class LRUCache extends LinkedHashMap { + + private final int maxSize; + private static final float LOAD_FACTOR = 0.75F; + + LRUCache(int maxSize) { + super(maxSize + 1, LOAD_FACTOR, true); + this.maxSize = maxSize; + } + + @Override + protected boolean removeEldestEntry(Map.Entry eldest) { + return size() > maxSize; + } +} diff --git a/src/main/java/fi/evident/elasticsearch/raudikko/analysis/MorphologyFactory.java b/src/main/java/fi/evident/elasticsearch/raudikko/analysis/MorphologyFactory.java new file mode 100644 index 0000000..951c95b --- /dev/null +++ b/src/main/java/fi/evident/elasticsearch/raudikko/analysis/MorphologyFactory.java @@ -0,0 +1,37 @@ +/* + * Copyright (C) 2021 Evident Solutions Oy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package fi.evident.elasticsearch.raudikko.analysis; + +import fi.evident.raudikko.Morphology; + +import java.lang.ref.SoftReference; + +public final class MorphologyFactory { + private static SoftReference reference; + + public static synchronized Morphology getInstance() { + Morphology instance = reference != null ? reference.get() : null; + if (instance == null) { + Morphology morphology = Morphology.loadBundled(); + reference = new SoftReference<>(morphology); + instance = morphology; + } + + return instance; + } +} diff --git a/src/main/java/fi/evident/elasticsearch/raudikko/analysis/RaudikkoTokenFilter.java b/src/main/java/fi/evident/elasticsearch/raudikko/analysis/RaudikkoTokenFilter.java new file mode 100644 index 0000000..be242e2 --- /dev/null +++ b/src/main/java/fi/evident/elasticsearch/raudikko/analysis/RaudikkoTokenFilter.java @@ -0,0 +1,120 @@ +/* + * Copyright (C) 2021 Evident Solutions Oy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + + +package fi.evident.elasticsearch.raudikko.analysis; + +import fi.evident.raudikko.Analyzer; +import org.apache.lucene.analysis.TokenFilter; +import org.apache.lucene.analysis.TokenStream; +import org.apache.lucene.analysis.tokenattributes.CharTermAttribute; +import org.apache.lucene.analysis.tokenattributes.PositionIncrementAttribute; + +import java.io.IOException; +import java.util.*; +import java.util.regex.Pattern; + +final class RaudikkoTokenFilter extends TokenFilter { + + private State current; + private final Analyzer raudikkoAnalyzer; + private final RaudikkoTokenFilterConfiguration cfg; + + private final CharTermAttribute charTermAttribute = addAttribute(CharTermAttribute.class); + private final PositionIncrementAttribute positionIncrementAttribute = addAttribute(PositionIncrementAttribute.class); + + private final Deque alternatives = new ArrayDeque<>(); + private final AnalysisCache analysisCache; + + private static final Pattern VALID_WORD_PATTERN = Pattern.compile("[a-zA-ZåäöÅÄÖ-]+"); + + RaudikkoTokenFilter(TokenStream input, + Analyzer analyzer, + AnalysisCache analysisCache, + RaudikkoTokenFilterConfiguration cfg) { + super(input); + this.raudikkoAnalyzer = analyzer; + this.analysisCache = analysisCache; + this.cfg = cfg; + } + + @Override + public boolean incrementToken() throws IOException { + if (!alternatives.isEmpty()) { + outputAlternative(alternatives.removeFirst()); + return true; + } + + if (input.incrementToken()) { + analyzeToken(); + return true; + } + + return false; + } + + private void analyzeToken() { + if (!isCandidateForAnalysis(charTermAttribute)) + return; + + List baseForms = analyze(charTermAttribute); + if (baseForms.isEmpty()) + return; + + charTermAttribute.setEmpty().append(baseForms.get(0)); + + if (cfg.analyzeAll && baseForms.size() > 1) { + current = captureState(); + + alternatives.addAll(baseForms.subList(1, baseForms.size())); + } + } + + private List analyze(CharSequence wordSeq) { + String word = wordSeq.toString(); + List result = analysisCache.get(word); + if (result == null) { + result = analyzeUncached(word); + analysisCache.put(word, result); + } + return result; + } + + private List analyzeUncached(String word) { + List results = raudikkoAnalyzer.baseForms(word); + + switch (results.size()) { + case 0: + return Collections.emptyList(); + case 1: + return Collections.singletonList(results.get(0)); + default: + return new ArrayList<>(results); + } + } + + private void outputAlternative(String token) { + restoreState(current); + + positionIncrementAttribute.setPositionIncrement(0); + charTermAttribute.setEmpty().append(token); + } + + private boolean isCandidateForAnalysis(CharSequence word) { + return word.length() >= cfg.minimumWordSize && word.length() <= cfg.maximumWordSize && VALID_WORD_PATTERN.matcher(word).matches(); + } +} diff --git a/src/main/java/fi/evident/elasticsearch/raudikko/analysis/RaudikkoTokenFilterConfiguration.java b/src/main/java/fi/evident/elasticsearch/raudikko/analysis/RaudikkoTokenFilterConfiguration.java new file mode 100644 index 0000000..68a9c26 --- /dev/null +++ b/src/main/java/fi/evident/elasticsearch/raudikko/analysis/RaudikkoTokenFilterConfiguration.java @@ -0,0 +1,31 @@ +/* + * Copyright (C) 2021 Evident Solutions Oy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package fi.evident.elasticsearch.raudikko.analysis; + +public class RaudikkoTokenFilterConfiguration { + + /** If true, use analysis candidates returned by Raudikko, otherwise use only the first result. */ + boolean analyzeAll = true; + + /** Words shorter than this threshold are ignored */ + int minimumWordSize = 3; + + /** Words longer than this threshold are ignored */ + int maximumWordSize = 100; + +} diff --git a/src/main/java/fi/evident/elasticsearch/raudikko/analysis/RaudikkoTokenFilterFactory.java b/src/main/java/fi/evident/elasticsearch/raudikko/analysis/RaudikkoTokenFilterFactory.java new file mode 100644 index 0000000..8931bd9 --- /dev/null +++ b/src/main/java/fi/evident/elasticsearch/raudikko/analysis/RaudikkoTokenFilterFactory.java @@ -0,0 +1,55 @@ +/* + * Copyright (C) 2021 Evident Solutions Oy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package fi.evident.elasticsearch.raudikko.analysis; + +import fi.evident.raudikko.Morphology; +import org.apache.lucene.analysis.TokenStream; +import org.elasticsearch.common.settings.Settings; +import org.elasticsearch.env.Environment; +import org.elasticsearch.index.IndexSettings; +import org.elasticsearch.index.analysis.AbstractTokenFilterFactory; + +public class RaudikkoTokenFilterFactory extends AbstractTokenFilterFactory { + + private final AnalysisCache analysisCache; + + private final RaudikkoTokenFilterConfiguration cfg = new RaudikkoTokenFilterConfiguration(); + + private final Morphology morphology; + + public RaudikkoTokenFilterFactory(IndexSettings indexSettings, + @SuppressWarnings("unused") Environment environment, + String name, + Settings settings) { + super(indexSettings, name, settings); + + cfg.analyzeAll = settings.getAsBoolean("analyzeAll", cfg.analyzeAll); + cfg.minimumWordSize = settings.getAsInt("minimumWordSize", cfg.minimumWordSize); + cfg.maximumWordSize = settings.getAsInt("maximumWordSize", cfg.maximumWordSize); + + analysisCache = new AnalysisCache(settings.getAsInt("analysisCacheSize", 1024)); + + // TODO support configurable morphology + this.morphology = MorphologyFactory.getInstance(); + } + + @Override + public TokenStream create(TokenStream tokenStream) { + return new RaudikkoTokenFilter(tokenStream, morphology.newAnalyzer(), analysisCache, cfg); + } +} diff --git a/src/main/java/fi/evident/elasticsearch/raudikko/plugin/AnalysisRaudikkoPlugin.java b/src/main/java/fi/evident/elasticsearch/raudikko/plugin/AnalysisRaudikkoPlugin.java new file mode 100644 index 0000000..5614fb5 --- /dev/null +++ b/src/main/java/fi/evident/elasticsearch/raudikko/plugin/AnalysisRaudikkoPlugin.java @@ -0,0 +1,47 @@ +/* + * Copyright (C) 2021 Evident Solutions Oy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package fi.evident.elasticsearch.raudikko.plugin; + +import fi.evident.elasticsearch.raudikko.analysis.FinnishTokenizerFactory; +import fi.evident.elasticsearch.raudikko.analysis.RaudikkoTokenFilterFactory; +import org.elasticsearch.index.analysis.TokenFilterFactory; +import org.elasticsearch.index.analysis.TokenizerFactory; +import org.elasticsearch.indices.analysis.AnalysisModule; +import org.elasticsearch.plugins.AnalysisPlugin; +import org.elasticsearch.plugins.Plugin; + +import java.util.HashMap; +import java.util.Map; + +import static java.util.Collections.singletonMap; + +public class AnalysisRaudikkoPlugin extends Plugin implements AnalysisPlugin { + + @Override + public Map> getTokenFilters() { + Map> map = new HashMap<>(); + map.put("raudikko", RaudikkoTokenFilterFactory::new); + map.put("voikko", RaudikkoTokenFilterFactory::new); + return map; + } + + @Override + public Map> getTokenizers() { + return singletonMap("finnish", FinnishTokenizerFactory::new); + } +} diff --git a/src/main/plugin-metadata/plugin-descriptor.properties b/src/main/plugin-metadata/plugin-descriptor.properties new file mode 100644 index 0000000..740cc21 --- /dev/null +++ b/src/main/plugin-metadata/plugin-descriptor.properties @@ -0,0 +1,6 @@ +name=elasticsearch-analysis-raudikko +version=${pluginVersion} +description=Raudikko Analysis for Elasticsearch +classname=fi.evident.elasticsearch.raudikko.plugin.AnalysisRaudikkoPlugin +java.version=${javaVersion} +elasticsearch.version=${elasticsearchVersion} diff --git a/src/test/java/fi/evident/elasticsearch/raudikko/analysis/RaudikkoTokenFilterTests.java b/src/test/java/fi/evident/elasticsearch/raudikko/analysis/RaudikkoTokenFilterTests.java new file mode 100644 index 0000000..6765b6f --- /dev/null +++ b/src/test/java/fi/evident/elasticsearch/raudikko/analysis/RaudikkoTokenFilterTests.java @@ -0,0 +1,172 @@ +/* + * Copyright (C) 2021 Evident Solutions Oy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package fi.evident.elasticsearch.raudikko.analysis; + +import org.apache.lucene.analysis.Analyzer; +import org.apache.lucene.analysis.TokenStream; +import org.apache.lucene.analysis.Tokenizer; +import org.apache.lucene.analysis.tokenattributes.CharTermAttribute; +import org.apache.lucene.analysis.tokenattributes.OffsetAttribute; +import org.apache.lucene.analysis.tokenattributes.PositionIncrementAttribute; +import org.junit.jupiter.api.Test; + +import java.io.IOException; +import java.io.StringReader; +import java.util.ArrayList; +import java.util.List; + +import static java.util.Arrays.asList; +import static org.junit.jupiter.api.Assertions.assertEquals; + +public class RaudikkoTokenFilterTests { + + private final RaudikkoTokenFilterConfiguration configuration = new RaudikkoTokenFilterConfiguration(); + + @Test + public void testDefaultSettings() { + assertTokens("Testaan voikon analyysiä tällä tavalla yksinkertaisesti.", + token("Testaan", "testata", 1), + token("voikon", "Voikko", 1), + token("voikon", "voikko", 0), + token("analyysiä", "analyysi", 1), + token("tällä", "tämä", 1), + token("tavalla", "tapa", 1), + token("yksinkertaisesti", "yksinkertainen", 1)); + } + + @Test + public void testDisableVariations() { + configuration.analyzeAll = false; + assertTokens("Testaan voikon analyysiä tällä tavalla yksinkertaisesti.", + token("Testaan", "testata", 1), + token("voikon", "Voikko", 1), + token("analyysiä", "analyysi", 1), + token("tällä", "tämä", 1), + token("tavalla", "tapa", 1), + token("yksinkertaisesti", "yksinkertainen", 1)); + } + + @Test + public void testNonSeparatedTokens() { + assertTokens("Testaan voikon analyysiä tällä tavalla yksinkertaisesti.", + token("Testaan", "testata", 1), + token("voikon", "Voikko", 1), + token("voikon", "voikko", 0), + token("analyysiä", "analyysi", 1), + token("tällä", "tämä", 1), + token("tavalla", "tapa", 1), + token("yksinkertaisesti", "yksinkertainen", 1)); + } + + @Test + public void testUnknownWord() { + assertTokens("Mitenkä foobarbaz edellinen sana tunnistetaan?", + token("Mitenkä", "miten", 1), + token("foobarbaz", "foobarbaz", 1), + token("edellinen", "edellinen", 1), + token("sana", "sana", 1), + token("tunnistetaan", "tunnistaa", 1)); + } + + @Test + public void testCompoundWords() { + assertTokens("isoisälle", token("isoisälle", "isoisä", 1)); + assertTokens("tekokuulla keinokuuhun", + token("tekokuulla", "tekokuu", 1), + token("keinokuuhun", "keinokuu", 1)); + } + + @Test + public void testCompoundWordsWithHyphens() { + assertTokens("rippi-isälle", token("rippi-isälle", "rippi-isä", 1)); + } + + private static TokenData token(String original, String token, int positionIncrement) { + return new TokenData(original, token, positionIncrement); + } + + private void assertTokens(String text, TokenData... expected) { + List tokens = parse(text); + assertEquals(asList(expected), tokens); + } + + private List parse(String text) { + Analyzer analyzer = new Analyzer() { + @Override + protected TokenStreamComponents createComponents(String fieldName) { + Tokenizer source = new FinnishTokenizer(); + TokenStream filter = new RaudikkoTokenFilter(source, MorphologyFactory.getInstance().newAnalyzer(), new AnalysisCache(100), configuration); + return new TokenStreamComponents(source, filter); + } + }; + + try { + try (TokenStream ts = analyzer.tokenStream("test", new StringReader(text))) { + List result = new ArrayList<>(); + CharTermAttribute charTerm = ts.addAttribute(CharTermAttribute.class); + OffsetAttribute offset = ts.addAttribute(OffsetAttribute.class); + PositionIncrementAttribute position = ts.addAttribute(PositionIncrementAttribute.class); + ts.reset(); + while (ts.incrementToken()) { + String original = text.substring(offset.startOffset(), offset.endOffset()); + result.add(token(original, charTerm.toString(), position.getPositionIncrement())); + } + ts.end(); + + return result; + } + } catch (IOException e) { + throw new RuntimeException(e); + } + } + + private static final class TokenData { + + private final String original; + private final String token; + private final int positionIncrement; + + TokenData(String original, String token, int positionIncrement) { + this.original = original; + this.token = token; + this.positionIncrement = positionIncrement; + } + + @Override + public String toString() { + return original + " -> " + token + " (+" + positionIncrement + ')'; + } + + @Override + public boolean equals(Object obj) { + if (this == obj) return true; + if (obj == null || getClass() != obj.getClass()) return false; + + TokenData tokenData = (TokenData) obj; + + return positionIncrement == tokenData.positionIncrement + && original.equals(tokenData.original) + && token.equals(tokenData.token); + } + + @Override + public int hashCode() { + return 31 * (31 * original.hashCode() + token.hashCode()) + positionIncrement; + } + } +}