API تحت JAVA فارس‌نت

شما می توانید از طریق API تحت JAVA به داده های شبکه واژگانی فارس‌نت در هر برنامه مبتنی بر JAVA دسترسی پیدا کنید. جهت دانلود API بایستی در سایت Login نمایید. پس از ورود به سایت منو دانلودها برای شما فعال خواهد شد.

این واسط حاوی یک کتابخانه jar فایل و یک پایگاه داده SQLite3 می باشد. هیچ وابستگی دیگر برای آن وجود ندارد و همه نیازمندی ها در فایلfarsnet.api.jar تعبیه شده است.



فایل jar شامل فایل های اصلی و فایل های جانبی ارتباط با پایگاه داده SQLite3 می باشد.



نحوه اضافه کردن به پروژه

با توجه به نوع محیط توسعه برنامه نویس می تواند با روش های مختلفی فایل ها را به برنامه اضافه کند. فایل پایگاه داده باید در root پروژه به عنوان یک فایل جانبی اضافه گردد و هنگام Build پروژه در کنار سایر خروجی های پروژه بدون هیچ فولدر بندی قرار گیرد.

در اینجا یک نمونه مثال برای محیط پر استفاده Eclipse برای توسعه دهنده گان جاوا ارائه می گردد.

1- بر روی پروژه Rightclick کنید و مسیر Build Path\ Configure Build Path انتخاب نمایید.

2- در این قسمت گزینه انتخاب Add External JARsکنید.



3- در این قسمت فایل Farsnet API را جستجو و اضافه کنید.



4- بعد از اضافه کردن فایل Farsnet API نوبت به اضافه کردن فایل پایگاه داده می رسد. بر روی پروژه Rightclick کنید و مسیر Import\ FileSystem انتخاب نمایید.

5- سپس مسیر فایل پایگاه داده را جستجو و انتخاب کنید.



6- در نهایتا خروجی فایل های اضافه شدن به شکل زیر خواهد بود.



7- در صورتیکه نوع پروژه وب می باشد. بایستی مسیر فایل Jar به Deployment Assemblyهم اضافه شود.



8- با کلیک بر کلید Add گزینه Java Build Path Entries از پنجره زیر انتخاب کنید.



9- با کلیک بر کلید Next گزینه farsnet.api را از پنجره زیر انتخاب کنید.



10- نهایتا فایل farsnet.api به محیط Deployment Assembly اضافه می شود.



نحوه استفاده در کد پروژه

بعد از اضافه کردن بعد از اضافه کردن کتابخانه farsnet.api به پروژه بایستی با import کردن package های برنامه در کلاس کد جاوا از آنها استفاده نمود.



برای شروع استفاده از API بایستی از کلاس SynsetService و SenseService استفاده نمود.

مطابق الگو زیر می توان از قابلیت ها و متدهای واسط برنامه نویسی فارس‌نت در محیط جاوا بهره برد.



پارامتر SearchStyle در getSensesByWord یا getSynsetsByWord تعیین کننده نوع جستجو است و شامل مقادیر زیر است:

  • LIKE مقدار کلمه شامل searchKeyword باشد.
  • START مقدار کلمه با searchKeyword شروع شود.
  • END مقدار کلمه با searchKeyword خاتمه یابد.
  • EXACT مقدار کلمه دقیقا با searchKeyword برابر باشد