From hibernate-commits at lists.jboss.org Sat May 16 05:59:36 2009 Content-Type: multipart/mixed; boundary="===============3702611871980758095==" MIME-Version: 1.0 From: hibernate-commits at lists.jboss.org To: hibernate-commits at lists.jboss.org Subject: [hibernate-commits] Hibernate SVN: r16575 - search/branches/Branch_3_1/src/main/docbook/en-US/modules. Date: Sat, 16 May 2009 05:54:26 -0400 Message-ID: --===============3702611871980758095== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: sannegrinovero Date: 2009-05-16 05:54:26 -0400 (Sat, 16 May 2009) New Revision: 16575 Modified: search/branches/Branch_3_1/src/main/docbook/en-US/modules/architecture.x= ml search/branches/Branch_3_1/src/main/docbook/en-US/modules/configuration.= xml search/branches/Branch_3_1/src/main/docbook/en-US/modules/getting-starte= d.xml search/branches/Branch_3_1/src/main/docbook/en-US/modules/lucene-native.= xml search/branches/Branch_3_1/src/main/docbook/en-US/modules/mapping.xml search/branches/Branch_3_1/src/main/docbook/en-US/modules/optimize.xml search/branches/Branch_3_1/src/main/docbook/en-US/modules/query.xml Log: HSEARCH-369 Running a spellchecker on documentation Modified: search/branches/Branch_3_1/src/main/docbook/en-US/modules/archite= cture.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- search/branches/Branch_3_1/src/main/docbook/en-US/modules/architecture.= xml 2009-05-16 09:47:42 UTC (rev 16574) +++ search/branches/Branch_3_1/src/main/docbook/en-US/modules/architecture.= xml 2009-05-16 09:54:26 UTC (rev 16575) @@ -219,7 +219,7 @@ Reader strategy = When executing a query, Hibernate Search interacts with the Apac= he - Lucene indexes through a reader strategy. chosing a reader strategy wi= ll + Lucene indexes through a reader strategy. Choosing a reader strategy w= ill depend on the profile of the application (frequent updates, read mostl= y, asynchronous index update etc). See also Modified: search/branches/Branch_3_1/src/main/docbook/en-US/modules/configu= ration.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- search/branches/Branch_3_1/src/main/docbook/en-US/modules/configuration= .xml 2009-05-16 09:47:42 UTC (rev 16574) +++ search/branches/Branch_3_1/src/main/docbook/en-US/modules/configuration= .xml 2009-05-16 09:54:26 UTC (rev 16575) @@ -312,8 +312,8 @@ =E2=80=9CAnimal=E2=80=9D. Both entities will then be stored in the= Animal directory = - hibernate.search.org.hibernate.search.= test.shards.Furniture.indexName =3D Aninal -hibernate.search.org.hibernate.search.test.shards.Animal.indexName =3D Ani= nal + hibernate.search.org.hibernate.search.= test.shards.Furniture.indexName =3D Animal +hibernate.search.org.hibernate.search.test.shards.Animal.indexName =3D Ani= mal = @@ -366,7 +366,7 @@ hibernate.search.worker.execution = - Supports synchronous and asynchrounous execution. Defau= lt + Supports synchronous and asynchronous execution. Default to sync. Supports also async. @@ -375,14 +375,14 @@ hibernate.search.worker.thread_pool.size = Defines the number of threads in the pool. useful only = for - asynchrounous execution. Default to 1. + asynchronous execution. Default to 1. = hibernate.search.worker.buffer_queue.max = Defines the maximal number of work queue if the thread = poll - is starved. Useful only for asynchrounous execution. Default to + is starved. Useful only for asynchronous execution. Default to infinite. If the limit is reached, the work is done by the main thread. @@ -439,7 +439,7 @@
Slave nodes = - Every index update operation is sent to a JMS queue. Index que= ring + Every index update operation is sent to a JMS queue. Index que= rying operations are executed on a local index copy. = @@ -763,7 +763,7 @@ terms. This silently truncates large documents, excluding from the index all terms that occur further in the document. If you know your source documents are large, be sure= to - set this value high enough to accomodate the expected size. If= you + set this value high enough to accommodate the expected size. I= f you set it to Integer.MAX_VALUE, then the only limit is your memor= y, but you should anticipate an OutOfMemoryError. If setting this value in batch differently tha= n in @@ -789,13 +789,13 @@ hibernate.search.[default|<indexname>].i= ndexwriter.[transaction|batch].merge_factor = Controls segment merge frequency and size. - Determines how often segment indices are merged when + Determines how often segment indexes are merged when insertion occurs. With smaller values, less RAM is used while - indexing, and searches on unoptimized indices are faster, but + indexing, and searches on unoptimized indexes are faster, but indexing speed is slower. With larger values, more RAM is used - during indexing, and while searches on unoptimized indices are + during indexing, and while searches on unoptimized indexes are slower, indexing is faster. Thus larger values (> 10) are b= est - for batch index creation, and smaller values (< 10) for ind= ices + for batch index creation, and smaller values (< 10) for ind= exes that are interactively maintained. The value must no be lower = than 2. = Modified: search/branches/Branch_3_1/src/main/docbook/en-US/modules/getting= -started.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- search/branches/Branch_3_1/src/main/docbook/en-US/modules/getting-start= ed.xml 2009-05-16 09:47:42 UTC (rev 16574) +++ search/branches/Branch_3_1/src/main/docbook/en-US/modules/getting-start= ed.xml 2009-05-16 09:54:26 UTC (rev 16575) @@ -160,7 +160,7 @@ = Not all dependencies are required. Only the - hibernate-search dependeny is mandatory. This + hibernate-search dependency is mandatory. This dependency, together with its required transitive dependencies, contain all required classes needed to use Hibernate Search. hibernate-annotations is only needed if you want = to @@ -173,7 +173,7 @@ use Hibernate Search in conjunction with JPA. The Solr dependencies are needed if you want to utilize Solr's analyzer framework. More about th= is later. And finally, the lucene-snowball dependency = is - needed if you want to utililze Lucene's snowball stemmer. + needed if you want to use Lucene's snowball stemmer.
=
@@ -230,7 +230,7 @@ = Example entities Book and Author before adding Hibernate Sear= ch - specific annotatons + specific annotations = package example; @@ -336,7 +336,7 @@ searchable you have to make sure that the names are indexed as part of= the book itself. On top of @IndexedEmbedded you will al= so have to mark all fields of the associated entity you want to have incl= uded - in the index with @Indexed. For more dedails see @Indexed. For more details see . = These settings should be sufficient for now. For more details on @@ -408,10 +408,10 @@ = Hibernate Search will transparently index every entity persisted, updated or removed through Hibernate Core. However, you have to trigge= r an - inital indexing to populate the Lucene index with the data already pre= sent + initial indexing to populate the Lucene index with the data already pr= esent in your database. Once you have added the above properties and annotat= ions it is time to trigger an initial batch index of your books. You can - achieve this by using one of the following code snipplets (see also ): = @@ -634,7 +634,7 @@ populated with the example code of this tutorial. = - Using the maven achetype to create tutorial sources + Using the Maven archetype to create tutorial sources = mvn archetype:create \ = -DarchetypeGroupId=3Dorg.hibernate \ Modified: search/branches/Branch_3_1/src/main/docbook/en-US/modules/lucene-= native.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- search/branches/Branch_3_1/src/main/docbook/en-US/modules/lucene-native= .xml 2009-05-16 09:47:42 UTC (rev 16574) +++ search/branches/Branch_3_1/src/main/docbook/en-US/modules/lucene-native= .xml 2009-05-16 09:54:26 UTC (rev 16575) @@ -81,7 +81,7 @@ citizen" rules. = - Accesing an <classname>IndexReader</classname> + Accessing an <classname>IndexReader</classname> = DirectoryProvider orderProvider =3D searchFactory.ge= tDirectoryProviders(Order.class)[0]; DirectoryProvider clientProvider =3D searchFactory.getDirectoryProviders(C= lient.class)[0]; @@ -129,7 +129,7 @@ = Lucene allows the user to customize its scoring formula by exten= ding org.apache.lucene.search.Similarity. The abstra= ct - methods defined in this class match the factors of the follownig formu= la + methods defined in this class match the factors of the following formu= la calculating the score of query q for document d: = score(q,d) =3D coord(q,d) =C2=B7 queryNo= rm(q) =C2=B7 @@ -205,7 +205,7 @@ @Similarity(impl =3D DummySimilarity.class) public class Book { ... -}As an exmaple, let's assume it is not important how ofte= n a +}As an example, let's assume it is not important how ofte= n a term appears in a document. Documents with a single occurrence of the = term should be scored the same as documents with multiple occurrences. In t= his case your custom implementation of the method tf(float Modified: search/branches/Branch_3_1/src/main/docbook/en-US/modules/mapping= .xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- search/branches/Branch_3_1/src/main/docbook/en-US/modules/mapping.xml 2= 009-05-16 09:47:42 UTC (rev 16574) +++ search/branches/Branch_3_1/src/main/docbook/en-US/modules/mapping.xml 2= 009-05-16 09:54:26 UTC (rev 16575) @@ -73,7 +73,7 @@ = For each property (or attribute) of your entity, you have the ability to describe how it will be indexed. The default (no annotati= on - present) means that the property is completly ignored by the indexing + present) means that the property is completely ignored by the indexi= ng process. @Field does declare a property as indexe= d. When indexing an element to a Lucene document you can specify how it= is indexed: @@ -88,7 +88,7 @@ store : describe whether or not the property is stored in the Lucene index. You can store the value - Store.YES (comsuming more space in the index = but + Store.YES (consuming more space in the index = but allowing projection, see for mo= re information), store it in a compressed way Store.COMPRESS (this does consume more CPU), = or @@ -103,8 +103,8 @@ information store. The different values are Index.NO (no indexing, ie cannot be found by a query), Index.TOKENIZED (use an analyzer to - process the property), Index.UN_TOKENISED (no - analyzer pre processing), Index.NO_NORM (do n= ot + process the property), Index.UN_TOKENIZED (no + analyzer pre-processing), Index.NO_NORMS (do = not store the normalization data). The default value is TOKENIZED. @@ -162,7 +162,7 @@ = TermVector.WITH_POSITIONS_OFFSETS + align=3D"left">TermVector.WITH_POSITION_OFFSETS = Store the term vector, token position and offset information. This is a combination of the YES, WITH_OFFS= ETS @@ -275,7 +275,7 @@ Embedded and associated objects = Associated objects as well as embedded objects can be indexed = as - part of the root entity index. This is ueful if you expect to search= a + part of the root entity index. This is useful if you expect to searc= h a given entity based on properties of associated objects. In the follo= wing example the aim is to return places where the associated city is Atl= anta (In the Lucene query parser language, it would translate into @@ -334,7 +334,7 @@ Address object to keep the index up to date. = To make sure the Place Lucene document is updated when it's Address changes, - you need to mark the other side of the birirectional relationship wi= th + you need to mark the other side of the bidirectional relationship wi= th @ContainedIn. = @ContainedIn is only useful on associations @@ -417,7 +417,7 @@ = - addess.ownedBy_name + address.ownedBy_name = @@ -434,7 +434,7 @@ graph contains a cyclic dependency of classes (not instances). For example, if Owner points to Place. Hibernate Search will stop including - Indexed embedded atttributes after reaching the expected depth (or t= he + Indexed embedded attributes after reaching the expected depth (or the object graph boundaries are reached). A class having a self referenc= e is an example of cyclic dependency. In our example, because depth is set to 1, any @@ -519,7 +519,7 @@ Boost factor = Lucene has the notion of boost factor. It= 's a - way to give more weigth to a field or to an indexed element over oth= ers + way to give more weight to a field or to an indexed element over oth= ers during the indexation process. You can use @Boost= at the @Field, method or class level. = @@ -649,7 +649,7 @@ This separation of tasks - a tokenizer followed by a list of filters - allows for easy reuse of each individual component and l= et you build your customized analyzer in a very flexible way (just li= ke - lego). Generally speaking the Tokenizer sta= rts + Lego). Generally speaking the Tokenizer sta= rts the analysis process by turning the character input into tokens wh= ich are then further processed by the TokenFilters. Hibernate Search supports this infrastructure by utilizing the Solr @@ -661,7 +661,7 @@ depend on more libraries. For example, the PhoneticFilterFactory depends on commons-codec. Your - distribution of Hibernate Search provides these dependecies in its + distribution of Hibernate Search provides these dependencies in its lib directory. = @@ -749,7 +749,7 @@ Let check a few of them. = - Some of the tokenizers avalable + Some of the available tokenizers = @@ -784,7 +784,7 @@
= - Some of the filters avalable + Some of the available filters = @@ -860,7 +860,7 @@ Analyzer discriminator (experimental) = So far all the introduced ways to specify an analyzer were - static. However, there are usecases where it is useful to select an + static. However, there are use cases where it is useful to select = an analyzer depending on the current state of the entity to be indexe= d, for example in multilingual application. For an BlogEntry class for example the analyzer co= uld @@ -947,7 +947,7 @@ interface has to return the name of an existing analyzer definitio= n if the analyzer should be set dynamically or null if the default analyzer should not be overridden. The given example - assumes that the language paramter is either 'de' or 'en' which + assumes that the language parameter is either 'de' or 'en' which matches the specified names in the @AnalyzerDefs. = @@ -1076,7 +1076,7 @@ important is that when using a DateRange Query, you should know that the dates have to be expressed in GMT time. = - Usually, storing the date up to the milisecond is not + Usually, storing the date up to the millisecond is not necessary. @DateBridge defines the appropri= ate resolution you are willing to store in the index ( @DateBridge(resolution=3DResolution.DAY) @@ -1213,8 +1213,8 @@ = The ParameterizedBridge interface can= be - implemented by StringBridge , - TwoWayStringBridge , + implemented by StringBridge, + TwoWayStringBridge, FieldBridge implementations. = All implementations have to be thread-safe, but the paramete= rs @@ -1276,13 +1276,13 @@
FieldBridge = - Some usecases require more than a simple object to string + Some use cases require more than a simple object to string translation when mapping a property to a Lucene index. To give you= the greatest possible flexibility you can also implement a bridge as a FieldBridge. This interface gives you a property value and let you map it the way you want in your Lucene Document.The interface is very similar in i= ts - concept to the Hibernate UserType's. + concept to the Hibernate UserTypes. = You can for example store a given property in two different document fields: Modified: search/branches/Branch_3_1/src/main/docbook/en-US/modules/optimiz= e.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- search/branches/Branch_3_1/src/main/docbook/en-US/modules/optimize.xml = 2009-05-16 09:47:42 UTC (rev 16574) +++ search/branches/Branch_3_1/src/main/docbook/en-US/modules/optimize.xml = 2009-05-16 09:54:26 UTC (rev 16575) @@ -35,7 +35,7 @@ During the optimization process the deletions will be applied which also effects the number of files in the Lucene Directory. = - Optimising the Lucene index speeds up searches but has no effect on + Optimizing the Lucene index speeds up searches but has no effect on the indexation (update) performance. During an optimization, searches ca= n be performed, but will most likely be slowed down. All index updates will be stopped. It is recommended to schedule optimization: @@ -61,7 +61,7 @@ = - or a certain amout of transactions + or a certain amount of transactions = @@ -129,7 +129,7 @@ Apache Lucene has a few parameters to influence how optimization= is performed. Hibernate Search exposes those parameters. = - Further index optimisation parameters include: + Further index optimization parameters include: hibernate.search.[default|<indexname>].indexwrite= r.[batch|transaction].max_buffered_docs Modified: search/branches/Branch_3_1/src/main/docbook/en-US/modules/query.x= ml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- search/branches/Branch_3_1/src/main/docbook/en-US/modules/query.xml 200= 9-05-16 09:47:42 UTC (rev 16574) +++ search/branches/Branch_3_1/src/main/docbook/en-US/modules/query.xml 200= 9-05-16 09:54:26 UTC (rev 16575) @@ -58,7 +58,7 @@ = To access the querying facilities, you have to use an - FullTextSession . This Search specfic session wra= ps a + FullTextSession. This Search specific session wra= ps a regular org.hibernate.Session to provide query and indexing capabilities. = @@ -179,7 +179,7 @@
Pagination = - Out of performace reasons it is recommended to restrict the + Out of performance reasons it is recommended to restrict the number of returned objects per query. In fact is a very common use case anyway that the user navigates from one page to an other. The= way to define pagination is exactly the way you would define paginatio= n in @@ -313,8 +313,8 @@ = - Projection is useful for another kind of usecases. Lucene - provides some metadata informations to the user about the results.= By + Projection is useful for another kind of use cases. Lucene + provides some metadata information to the user about the results. = By using some special placeholders, the projection mechanism can retr= ieve them: = @@ -335,7 +335,7 @@ = - FullTextQuery.THIS: returns the intialized and managed + FullTextQuery.THIS: returns the initialized and managed entity (as a non projected query would have done). = @@ -346,7 +346,7 @@ = FullTextQuery.OBJECT_CLASS: returns the class of the - indexded entity. + indexed entity. = @@ -471,7 +471,7 @@ the targeted data structure: = - Using ResultTransformer in conjuncton with projections</tit= le> + <title>Using ResultTransformer in conjunction with projections</ti= tle> = <programlisting>org.hibernate.search.FullTextQuery query =3D s.cre= ateFullTextQuery( luceneQuery, Book.class ); query.setProjection( "title", "mainAuthor.name" ); @@ -551,7 +551,7 @@ <para>Apache Lucene has a powerful feature that allows to filter query results according to a custom filtering process. This is a very powerf= ul way to apply additional data restrictions, especially since filters ca= n be - cached and reused. Some interesting usecases are:</para> + cached and reused. Some interesting use cases are:</para> = <itemizedlist> <listitem> @@ -674,7 +674,7 @@ filter or filter factory of the targeted named filter definition.</par= a> = <example> - <title>Using paramters in the actual filter implementation + Using parameters in the actual filter implementation = public class SecurityFilterFactory { private Integer level; @@ -704,7 +704,7 @@ Note the method annotated @Key returning a FilterKey object. The returned object has a spe= cial contract: the key object must implement equals() - / hashcode() so that 2 keys are equal if and = only + / hashCode() so that 2 keys are equal if and = only if the given Filter types are the same and the = set of parameters are the same. In other words, 2 filter keys are equal if= and only if the filters from which the keys are generated can be interchan= ged. @@ -725,7 +725,7 @@ = In most cases, using the StandardFilterKey implementation will be good enough. It delegates the - equals() / hashcode() + equals() / hashCode() implementation to each of the parameters equals and hashcode methods. = @@ -734,11 +734,11 @@ of memory when needed. The hard reference cache keeps track of the most recently used filters and transforms the ones least used to SoftReferences when needed. Once the limit of t= he - hard reference cache is reached addtional filters are cached as + hard reference cache is reached additional filters are cached as SoftReferences. To adjust the size of the hard reference cache, use hibernate.search.filter.cache_strategy.size (defaul= ts - to 128). For advance use of filter caching, you can implement your own + to 128). For advanced use of filter caching, you can implement your own FilterCachingStrategy. The classname is defined= by hibernate.search.filter.cache_strategy. = @@ -769,12 +769,12 @@ (org.hibernate.search.filter.CachingWrapperFilter). In contrast to Lucene's version of this class SoftReferences are used together with a hard - reference count (see dicussion about filter cache). The hard reference + reference count (see discussion about filter cache). The hard reference count can be adjusted using hibernate.search.filter.cache_docidresults.size (defaults to 5). The wrapping behaviour can be controlled using the @FullTextFilterDef.cache parameter. There are three - differerent values for this parameter: + different values for this parameter: = @@ -866,6 +866,6 @@ = If you wish to use some specific features of Lucene, you can alw= ays run Lucene specific queries. Check - for more informations. + for more information.
--===============3702611871980758095==--