Open SiteSearch 4.1.1
Final

ORG.oclc.qparse
Class Map

java.lang.Object
  |
  +--ORG.oclc.qparse.Map
public class Map
extends Object

The Map class maintains an individual index definition and provides methods to access the data.

See Also:
IndexMap

Field Summary
protected  String abbrev
          String data type containing the index abbreviation.
protected  int alternateId
          integer data type for the newton IndexId for local databases and the "real" use attribute value for remote Z39 databases.
protected  String alternateIdString
          String data type containing the alternateId value that is mapped from the incoming Z3950 use/structure attributes.
protected  boolean cleanForQuery
          boolean data type indicating whether default query filtering should be performed for terms using this index where default = true.
protected  String Completeness
          The Z3950 Completeness attribute value.
protected  TermNormalizer filter
          TermNormalizer object for the index to provide specialized query filter capabilities for the query term in this index.
protected  boolean fPhrase
          boolean data type indicating whether to treat the index as a phrase.
protected  boolean fPlural
          boolean data type indicating whether to allow plural searching.
protected  boolean fQuotes
          boolean data type indicating whether to automatically add Quotes to the term this index this qualifies.
protected  boolean fRange
          boolean data type indicating whether to allow range searching.
protected  boolean fRelation
          boolean data type indicating whether to allow Z39.50 Realtion Attributes.
protected  boolean fRestrictor
          boolean data type indicating whether index is a restrictor - meaning it is not searchable unless it appears in a boolean search.
protected  boolean fTrunc
          boolean data type indicating whether to allow Z39.50 Truncation Attributes.
protected  boolean fWithin
          boolean data type indicating whether to allow the "within" Z39.50 Realtion op.
protected  boolean hideInLists
          boolean data type indicating whether this index should appear in any of the [indexlists] when the shorthand notation is used such as 'all', 'phrases', 'words'.
protected  String longName
          String data type containing the long name of the index.
protected  String name
          String data type containing the name of the index.
protected  String Position
          The Z3950 Position attribute value.
protected  String range_max
          String data type containg the maximum for ranges.
protected  String range_min
          String data type containing the minimum for the range.
protected  String Relation
          The Z3950 Relation attribute value.
protected  DataPairs restrictorValues
          DataPairs object containing a list of strings to search the restrictor with.
protected  String searchId
          String data type containing the fully qualified Z3950 search string.
protected  StopWord stopwords
          Index Specific stopwords list.
protected  int Structure
          integer data type for the Z3950 structure attribute value.
protected  String Truncation
          The Z3950 Truncation attribute value.
protected  int Use
          integer data type for the Z3950 use attribute value.
 
Constructor Summary
Map()
          Construct a Map object.
 
Method Summary
 boolean allowTruncation()
          Returns boolean indicating whether to look for truncation masks ('#', '*', or '?') in search terms.
 boolean allowWithin()
          Returns boolean indicating whether to target supports within relation operator (r=104;)
 boolean canBePlural()
          Returns boolean indicating whether the plural searching is available.
 boolean cleanForQuery()
          Returns a boolean indicating whether the query should be cleaned up when making a Z3950 query.
 Object clone()
          Creates a copy of the Object.
 boolean doQuotes()
          Returns boolean indicating whether the object the index qualifies should automatically have quotes added (during term collection).
 boolean doRelation()
          Returns boolean indicating whether the object the index qualifies should automatically have Relation attributes added.
 String getAbb()
          Returns a String containing the index abbreviation.
 String getAlternateIdString()
          Returns a String containing the alternateId value.
 int getCompleteness()
          Gets the Completeness attribute value.
 String getCompletenessString()
          Gets the String defining the Completeness attribute value according to the Z39.50 Standard definition
 String getIndex()
          Returns a String containing the fully qualified String to add to the Z39.50 type query.
 int getIndexValue()
          Returns an integer containing the alternateId value.
 String getLongName()
          Returns a String containing the long name of the index.
 String getName()
          Returns a String containing the name of the index.
 int getPosition()
          Gets the Position attribute value.
 String getPositionString()
          Gets the String defining the Position attribute value according to the Z39.50 Standard definition
 String getRangeMax(String term)
          Returns a String containing the range maximum value.
 String getRangeMin(String term)
          Returns a String containing the range minimum value.
 int getRelation()
          Gets the Relation attribute value.
 String getRelationString()
          Gets the String defining the Relation attribute value according to the Z39.50 Standard definition
 DataPairs getRestrictorValues()
          Returns a DataPairs object with the list of possible name=value pairs for the index.
 int getStructure()
          Returns the integer for the structure attribute value.
 String getStructureString()
          Gets the String defining the Structure attribute value according to the Z39.50 Standard definition
 int getTruncation()
          Gets the Truncation attribute value.
 String getTruncationString()
          Gets the String defining the Truncation attribute value according to the Z39.50 Standard definition
 int getUse()
          Returns the integer for the Use attribute value.
 boolean hideInLists()
          Returns boolean indicating whether index is should be included in any shorthand lists for [indexlists]
 boolean isPhrase()
          Returns boolean indicating whether index is a phrase type.
 boolean isPlural()
          Returns boolean indicating whether the plural searching is active.
 boolean isRangeable()
          Returns boolean indicating whether the index is rangeable.
 boolean isRestrictor()
          Returns boolean indicating whether index is a restrictor.
 String name()
          Returns a String containing the name of the index.
 void putIniData(IniFile ini, IndexMap parent)
           
 Class queryNormalizerClass()
          Deprecated. use termNormalizerClass()
 void setAbb(String abb)
          Sets the abbreviation.
 void setalternateId(int id)
          Sets the alternateId value.
 void setalternateId(String id)
          Sets the alternateId value to the incoming String.
 void setCompleteness(String completeness)
          Sets the Completeness attribute value.
 void setFilter(String classname)
          Sets the filter up for the index
 void setLongName(String name)
          Sets the textual long name of the index.
 void setName(String name)
          Sets the name of the index.
 void setPhrase()
          Sets the flag indicating that the index is a phrase type index
 void setPluralFlag(boolean flag)
          Sets the plural flag.
 void setPosition(String position)
          Sets the Position attribute value.
 void setRangeFlag(boolean flag)
          Sets the range flag.
 void setRangeMax(String max)
          Sets the range maximum.
 void setRangeMin(String min)
          Sets the range minimum.
 void setRelation(String relation)
          Sets the Relation attribute value.
 void setRestrictorFlag(boolean flag)
          Sets the restrictor flag.
 void setStructure(int structure)
          Sets the structure attribute value.
 void setTruncation(String truncation)
          Sets the Truncation attribute value.
 void setTruncationFlag(boolean flag)
          Sets the plural flag.
 void setUse(int use)
          Sets the use attribute value.
 StopWord stopwords()
          Returns the index specific StopWord object.
 Class termNormalizerClass()
          Returns a Class object for normalizing(filtering) the query.
 TermNormalizer termNormalizerObject()
          Returns the TermNormalizer object for filtering the term.
 String toIniString()
          Generates an IniFile type string representation of the object.
 String toString()
          Generates a String representation of the object.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

Use

protected int Use
integer data type for the Z3950 use attribute value.

Structure

protected int Structure
integer data type for the Z3950 structure attribute value.

Relation

protected String Relation
The Z3950 Relation attribute value.

Position

protected String Position
The Z3950 Position attribute value.

Truncation

protected String Truncation
The Z3950 Truncation attribute value.

Completeness

protected String Completeness
The Z3950 Completeness attribute value.

alternateId

protected int alternateId
integer data type for the newton IndexId for local databases and the "real" use attribute value for remote Z39 databases.

alternateIdString

protected String alternateIdString
String data type containing the alternateId value that is mapped from the incoming Z3950 use/structure attributes.

searchId

protected String searchId
String data type containing the fully qualified Z3950 search string.

fPhrase

protected boolean fPhrase
boolean data type indicating whether to treat the index as a phrase.

fQuotes

protected boolean fQuotes
boolean data type indicating whether to automatically add Quotes to the term this index this qualifies.

fPlural

protected boolean fPlural
boolean data type indicating whether to allow plural searching.

fRange

protected boolean fRange
boolean data type indicating whether to allow range searching.

fRelation

protected boolean fRelation
boolean data type indicating whether to allow Z39.50 Realtion Attributes.

fWithin

protected boolean fWithin
boolean data type indicating whether to allow the "within" Z39.50 Realtion op. (r=104;)

fTrunc

protected boolean fTrunc
boolean data type indicating whether to allow Z39.50 Truncation Attributes.

range_min

protected String range_min
String data type containing the minimum for the range.

range_max

protected String range_max
String data type containg the maximum for ranges.

abbrev

protected String abbrev
String data type containing the index abbreviation.

longName

protected String longName
String data type containing the long name of the index.

name

protected String name
String data type containing the name of the index.

fRestrictor

protected boolean fRestrictor
boolean data type indicating whether index is a restrictor - meaning it is not searchable unless it appears in a boolean search.

hideInLists

protected boolean hideInLists
boolean data type indicating whether this index should appear in any of the [indexlists] when the shorthand notation is used such as 'all', 'phrases', 'words'.

restrictorValues

protected DataPairs restrictorValues
DataPairs object containing a list of strings to search the restrictor with.
DisplayString=InternalSearchString (e.g., English:eng)

cleanForQuery

protected boolean cleanForQuery
boolean data type indicating whether default query filtering should be performed for terms using this index where default = true.

filter

protected TermNormalizer filter
TermNormalizer object for the index to provide specialized query filter capabilities for the query term in this index.

stopwords

protected StopWord stopwords
Index Specific stopwords list.
Constructor Detail

Map

public Map()
Construct a Map object.
Method Detail

setalternateId

public final void setalternateId(int id)
Sets the alternateId value.
Parameters:
id - the value

setalternateId

public final void setalternateId(String id)
Sets the alternateId value to the incoming String.
Parameters:
id - the value

setUse

public final void setUse(int use)
Sets the use attribute value.
Parameters:
use -  

setStructure

public final void setStructure(int structure)
Sets the structure attribute value.
Parameters:
structure -  

setRelation

public final void setRelation(String relation)
Sets the Relation attribute value.
Parameters:
relation -  

setPosition

public final void setPosition(String position)
Sets the Position attribute value.
Parameters:
position -  

setTruncation

public final void setTruncation(String truncation)
Sets the Truncation attribute value.
Parameters:
truncation -  

setCompleteness

public final void setCompleteness(String completeness)
Sets the Completeness attribute value.
Parameters:
completeness -  

setAbb

public final void setAbb(String abb)
Sets the abbreviation.
Parameters:
abb -  

setRangeFlag

public final void setRangeFlag(boolean flag)
Sets the range flag.
Parameters:
flag -  

setPluralFlag

public final void setPluralFlag(boolean flag)
Sets the plural flag.
Parameters:
flag -  

setTruncationFlag

public final void setTruncationFlag(boolean flag)
Sets the plural flag.
Parameters:
flag -  

setRestrictorFlag

public final void setRestrictorFlag(boolean flag)
Sets the restrictor flag.
Parameters:
flag -  

setRangeMax

public final void setRangeMax(String max)
Sets the range maximum.
Parameters:
max -  

setRangeMin

public final void setRangeMin(String min)
Sets the range minimum.
Parameters:
min -  

setLongName

public final void setLongName(String name)
Sets the textual long name of the index.
Parameters:
name -  

setName

public final void setName(String name)
Sets the name of the index.
Parameters:
name -  

getAbb

public final String getAbb()
Returns a String containing the index abbreviation.
Returns:
String

getAlternateIdString

public final String getAlternateIdString()
Returns a String containing the alternateId value.
Returns:
String

getIndexValue

public final int getIndexValue()
Returns an integer containing the alternateId value.
Returns:
int

getName

public final String getName()
Returns a String containing the name of the index.
Returns:
String

getLongName

public final String getLongName()
Returns a String containing the long name of the index.
Returns:
String

name

public final String name()
Returns a String containing the name of the index.
Returns:
String

getRelation

public final int getRelation()
Gets the Relation attribute value.
Returns:
String

getRelationString

public final String getRelationString()
Gets the String defining the Relation attribute value according to the Z39.50 Standard definition
Returns:
String

getPosition

public final int getPosition()
Gets the Position attribute value.
Returns:
String

getPositionString

public final String getPositionString()
Gets the String defining the Position attribute value according to the Z39.50 Standard definition
Returns:
String

getTruncation

public final int getTruncation()
Gets the Truncation attribute value.
Returns:
String

getTruncationString

public final String getTruncationString()
Gets the String defining the Truncation attribute value according to the Z39.50 Standard definition
Returns:
String

getCompleteness

public final int getCompleteness()
Gets the Completeness attribute value.
Returns:
String

getCompletenessString

public final String getCompletenessString()
Gets the String defining the Completeness attribute value according to the Z39.50 Standard definition
Returns:
String

queryNormalizerClass

public final Class queryNormalizerClass()
Deprecated. use termNormalizerClass()
Returns a Class object for normalizing(filtering) the query.
Returns:
Class

termNormalizerClass

public final Class termNormalizerClass()
Returns a Class object for normalizing(filtering) the query.
Returns:
Class

termNormalizerObject

public final TermNormalizer termNormalizerObject()
Returns the TermNormalizer object for filtering the term.
Returns:
TermNormalizer

stopwords

public final StopWord stopwords()
Returns the index specific StopWord object.
Returns:
StopWord

putIniData

public void putIniData(IniFile ini,
                       IndexMap parent)

toIniString

public String toIniString()
Generates an IniFile type string representation of the object.
Returns:
String

toString

public String toString()
Generates a String representation of the object.
Returns:
String
Overrides:
toString in class Object

getIndex

public final String getIndex()
Returns a String containing the fully qualified String to add to the Z39.50 type query.
Returns:
String

cleanForQuery

public final boolean cleanForQuery()
Returns a boolean indicating whether the query should be cleaned up when making a Z3950 query.
Returns:
boolean

isPhrase

public final boolean isPhrase()
Returns boolean indicating whether index is a phrase type.
Returns:
boolean

setPhrase

public final void setPhrase()
Sets the flag indicating that the index is a phrase type index

setFilter

public final void setFilter(String classname)
Sets the filter up for the index

hideInLists

public final boolean hideInLists()
Returns boolean indicating whether index is should be included in any shorthand lists for [indexlists]
Returns:
boolean

isRestrictor

public final boolean isRestrictor()
Returns boolean indicating whether index is a restrictor.
Returns:
boolean

getRestrictorValues

public final DataPairs getRestrictorValues()
Returns a DataPairs object with the list of possible name=value pairs for the index.
Returns:
DataPairs

doQuotes

public final boolean doQuotes()
Returns boolean indicating whether the object the index qualifies should automatically have quotes added (during term collection). Indexes with structure phrase are quoted by default.
Returns:
boolean

doRelation

public final boolean doRelation()
Returns boolean indicating whether the object the index qualifies should automatically have Relation attributes added. (e.g., 1990-2100/u=30;s=5;r=3;)
Returns:
boolean

getUse

public final int getUse()
Returns the integer for the Use attribute value.
Returns:
int

getStructure

public final int getStructure()
Returns the integer for the structure attribute value.
Returns:
int

getStructureString

public final String getStructureString()
Gets the String defining the Structure attribute value according to the Z39.50 Standard definition
Returns:
String

getRangeMin

public final String getRangeMin(String term)
Returns a String containing the range minimum value.
Returns:
String

getRangeMax

public final String getRangeMax(String term)
Returns a String containing the range maximum value.
Returns:
String

canBePlural

public final boolean canBePlural()
Returns boolean indicating whether the plural searching is available.
Returns:
boolean

isPlural

public final boolean isPlural()
Returns boolean indicating whether the plural searching is active.
Returns:
boolean

allowTruncation

public final boolean allowTruncation()
Returns boolean indicating whether to look for truncation masks ('#', '*', or '?') in search terms.
Returns:
boolean

allowWithin

public final boolean allowWithin()
Returns boolean indicating whether to target supports within relation operator (r=104;)
Returns:
boolean

isRangeable

public final boolean isRangeable()
Returns boolean indicating whether the index is rangeable.
Returns:
boolean

clone

public Object clone()
Creates a copy of the Object.
Returns:
Object
Overrides:
clone in class Object
Open SiteSearch 4.1.1
Final