You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by Bernhard Messer <Be...@intrafind.de> on 2004/10/11 18:21:43 UTC

documentation in fileformats.html

hi Christoph,

first of all, many thanks for reviewing and at least adding the binary  
and compression patch to lucene. What we still have to do, before 
finalizing the implementation, is to update the documentation describing 
the field data in fileformats.html. The sentence

"Currently only the low-order bit is used of Bits is used. It is one for 
tokenized fields, and zero for non-tokenized fields."

is outdated now and should be updated. Any idea how to proceed ?

best regards
Bernhard

---------------------------------------------------------------------
To unsubscribe, e-mail: lucene-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: lucene-dev-help@jakarta.apache.org


Re: documentation in fileformats.html

Posted by Daniel Naber <da...@t-online.de>.
On Wednesday 13 October 2004 23:18, Doug Cutting wrote:

> We should note that when compression is enabled, gzip is used.

Actually it's ZLIB, isn't it?

> Also, byte[] is not a type defined in the file.  In the formalism used
> in fileformats.html, this should be:
>
> Value -> String | BinaryValue (depending on Bits)
>
> BinaryValue -> ValueSize, <Byte>^ValueSize
> ValueSize -> VInt

I committed these changes.

Regards
 Daniel

-- 
http://www.danielnaber.de

---------------------------------------------------------------------
To unsubscribe, e-mail: lucene-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: lucene-dev-help@jakarta.apache.org


Re: documentation in fileformats.html

Posted by Doug Cutting <cu...@apache.org>.
Daniel Naber wrote:
> The web page is updated now, could you please re-check if it's correct? I 
> added that information so that the Lucene <= 1.4 format is still there.

We should note that when compression is enabled, gzip is used.

Also, byte[] is not a type defined in the file.  In the formalism used 
in fileformats.html, this should be:

Value -> String | BinaryValue (depending on Bits)

BinaryValue -> ValueSize, <Byte>^ValueSize
ValueSize -> VInt

Doug

---------------------------------------------------------------------
To unsubscribe, e-mail: lucene-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: lucene-dev-help@jakarta.apache.org


Re: documentation in fileformats.html

Posted by Daniel Naber <da...@t-online.de>.
On Monday 11 October 2004 23:10, Bernhard Messer wrote:

> replace:
>
> Bits --> Byte
>
> Value --> String
>
> Currently only the low-order bit is used of Bits is used. It is one for
> tokenized fields, and zero for non-tokenized fields.

The web page is updated now, could you please re-check if it's correct? I 
added that information so that the Lucene <= 1.4 format is still there.

Regards
 Daniel

-- 
http://www.danielnaber.de

---------------------------------------------------------------------
To unsubscribe, e-mail: lucene-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: lucene-dev-help@jakarta.apache.org


Re: documentation in fileformats.html

Posted by Bernhard Messer <Be...@intrafind.de>.
Daniel Naber wrote:

>On Monday 11 October 2004 18:21, Bernhard Messer wrote:
>
>  
>
>>"Currently only the low-order bit is used of Bits is used. It is one for
>>tokenized fields, and zero for non-tokenized fields."
>>
>>is outdated now and should be updated. Any idea how to proceed ?
>>    
>>
>
>Is that the only sentence? If so, you could send the new sentence/paragraph 
>to this list and someone will add it to the documentation in CVS.
>  
>
replace:

Bits --> Byte

Value --> String

Currently only the low-order bit is used of Bits is used. It is one for 
tokenized fields, and zero for non-tokenized fields.

with:

Bits --> Byte
- low order bit is one for tokenized fields.
- second bit is one for fields containing binary data.
- third bit is one for fields with compression option enabled.

Value --> String (default) or byte[] when the field value is a binary field

regards
Bernhard



Re: documentation in fileformats.html

Posted by Daniel Naber <da...@t-online.de>.
On Monday 11 October 2004 18:21, Bernhard Messer wrote:

> "Currently only the low-order bit is used of Bits is used. It is one for
> tokenized fields, and zero for non-tokenized fields."
>
> is outdated now and should be updated. Any idea how to proceed ?

Is that the only sentence? If so, you could send the new sentence/paragraph 
to this list and someone will add it to the documentation in CVS.

Regards
 Daniel

-- 
http://www.danielnaber.de

---------------------------------------------------------------------
To unsubscribe, e-mail: lucene-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: lucene-dev-help@jakarta.apache.org