Fieldable.cs

Go to the documentation of this file.

/* 
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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
 * 
 * http://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.
 */

using System;
using System.IO;
using TokenStream = Lucene.Net.Analysis.TokenStream;
using FieldInvertState = Lucene.Net.Index.FieldInvertState;

namespace Lucene.Net.Documents
{
    public interface IFieldable
    {
        float Boost { get; set; }

        string Name { get; }

        string StringValue { get; }

        TextReader ReaderValue { get; }

        TokenStream TokenStreamValue { get; }

        bool IsStored { get; }

        bool IsIndexed { get; }

        bool IsTokenized { get; }

        bool IsTermVectorStored { get; }

        bool IsStoreOffsetWithTermVector { get; }

        bool IsStorePositionWithTermVector { get; }

        bool IsBinary { get; }

        bool OmitNorms { get; set; }


        bool IsLazy { get; }

        int BinaryOffset { get; }

        int BinaryLength { get; }

        byte[] GetBinaryValue();

        byte[] GetBinaryValue(byte[] result);

        bool OmitTermFreqAndPositions { set; get; }
    }
}