Lucene-haun osapuolet

org.eclipse.help.base.luceneSearchParticipants

3.2

Tämän laajennuspisteen avulla voit lisätä asiakirjasisältöä Lucene-haun indeksiin. Voit lisätä haun osapuolen kahdessa tapauksessa:
  1. Jos haluat indeksoida asiakirjoja, jotka on rekisteröity ohjejärjestelmän sisällysluetteloon, mutta jotka eivät ole HTML-muodossa (esimerkiksi XML). Tässä tapauksessa osapuolen on esiteltävä tiedoston tunnisteet, jotka se voi käsitellä.Sitä kutsutaan indeksoimaan kukin vastaava asiakirja. Tässä tapauksessa osapuolen vaikutusalue on lisäosa.
  2. Jos haluat indeksoida ohjejärjestelmän sisällysluettelon ulkopuolisia asiakirjoja. Tässä tapauksessa osapuolelle annetaan mahdollisuus indeksoida kerralla kaikki asiakirjat, jotka se tuntee. Lisäksi osapuolelle kuuluu hakutulosten avaaminen, koska ohjejärjestelmä ei tiedä, kuinka avata sisällysluettelon ulkopuolisia asiakirjoja. Tässä tapauksessa osapuolen vaikutusalue on yleinen.

Haun osapuolet liittyvät lisäosaan, jossa laajennus on. Jos haluat käyttää osapuolia uudelleen muissa lisäosissa, niihin on oltava binding-viittaus. Tämä estää lisäosaa ottamasta osapuolta käyttöön koko tuotteessa niiden tiedoston tunnisteiden osalta, joihin se on rekisteröity. Lisäämällä nimenomaisen viittauksen lisäosa määrittää, että se sallii viitatun haun osapuolen käsittelevän sellaisten asiakirjojen indeksoinnin, joissa on kyseiset tunnisteet. Niiden asiakirjojen osalta, jotka eivät ole osa sisällysluetteloa, tällaista vaaraa ei ole. Tämän vuoksi ne ovat yleisiä eikä binding ole tarpeen.

<!ELEMENT extension (searchParticipant | binding)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT searchParticipant (participant?)>

<!ATTLIST searchParticipant

id          CDATA #REQUIRED

name        CDATA #IMPLIED

icon        CDATA #IMPLIED

participant CDATA #IMPLIED

extensions  CDATA #IMPLIED

headless    (true | false) "false">


<!ELEMENT participant (parameter*)>

<!ATTLIST participant

class CDATA #IMPLIED>


<!ELEMENT parameter EMPTY>

<!ATTLIST parameter

name  CDATA #REQUIRED

value CDATA #REQUIRED>


<!ELEMENT binding EMPTY>

<!ATTLIST binding

participantId CDATA #IMPLIED>


Seuraavassa on laajennuspisteen käyttöesimerkki:

  

<extension point=

"org.eclipse.help.base.luceneSearchParticipant"

>

<searchParticipant id=

"org.eclipse.myGlobalParticipant"

name=

"Global Participant"

icon=

"icons/mydoc.gif"

participant=

"org.eclipse.myPlugin.myPackage.MyGlobalParticipant"

headless=

"true"

/>

<searchParticipant id=

"org.eclipse.myXYZParticipant"

extensions=

"xyz"

participant=

"org.eclipse.myPlugin.myPackage.MyXYZParticipant"

/>

</extension>

Toimitetun haun osapuolen on laajennettava abstraktia luokkaa org.eclipse.help.search.LuceneSearchParticipant.

Ohjejärjestelmässä on haun osapuoli XHTML-tiedostoille (xhtml-laajennus). Lisäosat, joilla on dynaamisia XHTML-asiakirjoja osana sisällysluetteloa, on sidottava tähän osapuoleen käyttäen binding-elementtiä ja org.eclipse.help.base.xhtml-objektia kohdeosapuolen tunnuksena.