001    /*
002        Licensed to the Apache Software Foundation (ASF) under one
003        or more contributor license agreements.  See the NOTICE file
004        distributed with this work for additional information
005        regarding copyright ownership.  The ASF licenses this file
006        to you under the Apache License, Version 2.0 (the
007        "License"); you may not use this file except in compliance
008        with the License.  You may obtain a copy of the License at
009    
010           http://www.apache.org/licenses/LICENSE-2.0
011    
012        Unless required by applicable law or agreed to in writing,
013        software distributed under the License is distributed on an
014        "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015        KIND, either express or implied.  See the License for the
016        specific language governing permissions and limitations
017        under the License.     
018     */
019    package org.apache.wiki.search;
020    
021    
022    /**
023     * This simple class just fulfils the role of a container for searches.  It tells the word and whether it is 
024     * requested or not.
025     */
026    public class QueryItem {
027        
028        /** The word is required to be in the pages */
029        public static final int REQUIRED  = 1;
030    
031        /** The word may NOT be in the pages */
032        public static final int FORBIDDEN = -1;
033    
034        /** The word should be in the pages, but the search engine may
035            use its own discretion. */
036        public static final int REQUESTED = 0;
037    
038        /** The word that is being searched */
039        public String word;
040    
041        /** The type of the word.  See above for types.  The default is REQUESTED. */
042        public int    type = REQUESTED;
043    
044    }