File	Doc	Category	Size	Date	Package
IndexSchema.java	API Doc	Apache Lucene 2.1.0	15639	Wed Feb 14 10:46:06 GMT 2007	org.apache.lucene.gdata.search.config

IndexSchema

• java.lang.Object

Fields Summary
private final Set	searchableFieldNames
private static final Log	LOG
public static final int	NOT_SET_VALUE a static final value for properties are not set by the configuration file this value will be set to all long and int properties by default
private static final int	DEFAULT_OPTIMIZE_COUNT
private static final int	DEFAULT_COMMIT_COUNT
private String	indexLocation
private String	name
private boolean	useTimedIndexer
private long	indexerIdleTime
private Analyzer	serviceAnalyzer
private String	defaultSearchField
private PerFieldAnalyzerWrapper	perFieldAnalyzer
private Collection	schemaFields
private int	maxBufferedDocs
private int	maxMergeDocs
private int	mergeFactor
private int	maxFieldLength
private long	writeLockTimeout
private long	commitLockTimeout
private int	commitAfterDocuments
private int	optimizeAfterCommit
private boolean	useCompoundFile

Constructors Summary
public IndexSchema() Creates a new IndexSchema and initialize the standard service analyzer to {@link StandardAnalyzer} this.schemaFields = new ArrayList<IndexSchemaField>(); /* * keep as standard if omitted in the configuration */ this.serviceAnalyzer = new StandardAnalyzer();

Methods Summary
public void	addSchemaField(IndexSchemaField field) Adds a new {@link IndexSchemaField} to the schema. if the fields name equals {@link IndexDocument#FIELD_ENTRY_ID} or the field is null it will simply ignored param field - the index schema field to add as a field of this schema. if (field == null) return; /* * skip fields configured in the gdata-config.xml file if their names * match a primary key field id of the IndexDocument */ if (field.getName().equals(IndexDocument.FIELD_ENTRY_ID) || field.getName().equals(IndexDocument.FIELD_FEED_ID)) return; if (field.getAnalyzerClass() != null) { /* * enable per field analyzer if one is set. */ Analyzer analyzer = getAnalyzerInstance(field.getAnalyzerClass()); /* * null values will be omitted here */ buildPerFieldAnalyzerWrapper(analyzer, field.getName()); } this.schemaFields.add(field); this.searchableFieldNames.add(field.getName());
private void	buildPerFieldAnalyzerWrapper(org.apache.lucene.analysis.Analyzer anazlyer, java.lang.String field) if (anazlyer == null || field == null || field.length() == 0) return; if (this.perFieldAnalyzer == null) this.perFieldAnalyzer = new PerFieldAnalyzerWrapper( this.serviceAnalyzer); this.perFieldAnalyzer.addAnalyzer(field, anazlyer);
public boolean	equals(java.lang.Object object) see java.lang.Object#equals(java.lang.Object) if (this == object) return true; if (object == null) return false; if (object instanceof IndexSchema) { if(this.name ==null) return super.equals(object); return this.name.equals(((IndexSchema) object).getName()); } return false;
private static org.apache.lucene.analysis.Analyzer	getAnalyzerInstance(java.lang.Class clazz) if (!ReflectionUtils.extendsType(clazz, Analyzer.class)) { LOG.warn("Can not create analyzer for class " + clazz.getName()); return null; } try { return clazz.newInstance(); } catch (Exception e) { LOG.warn("Can not create analyzer for class " + clazz.getName()); } return null;
public int	getCommitAfterDocuments() Defines after how many added,removed or updated document the indexer should commit. return Returns the commitAfterDocuments. return this.commitAfterDocuments;
public long	getCommitLockTimeout() return Returns the commitLockTimout. return this.commitLockTimeout;
public java.lang.String	getDefaultSearchField() return Returns the defaultField. return this.defaultSearchField;
public java.util.Collection	getFields() return Returns the fieldConfiguration. return this.schemaFields;
public java.lang.String	getIndexLocation() return Returns the indexLocation. return this.indexLocation;
public long	getIndexerIdleTime() return Returns the indexerIdleTime. return this.indexerIdleTime;
public int	getMaxBufferedDocs() return Returns the maxBufferedDocs. return this.maxBufferedDocs;
public int	getMaxFieldLength() return Returns the maxFieldLength. return this.maxFieldLength;
public int	getMaxMergeDocs() return Returns the maxMergeDocs. return this.maxMergeDocs;
public int	getMergeFactor() return Returns the mergeFactor. return this.mergeFactor;
public java.lang.String	getName() return Returns the name. return this.name;
public int	getOptimizeAfterCommit() Defines after how many commits the indexer should optimize the index return Returns the optimizeAfterCommit. return this.optimizeAfterCommit;
public org.apache.lucene.analysis.Analyzer	getSchemaAnalyzer() return - the analyzer instance to be used for this schema if (this.perFieldAnalyzer == null) return this.serviceAnalyzer; return this.perFieldAnalyzer;
public java.util.Set	getSearchableFieldNames() return Returns the searchableFieldNames. return this.searchableFieldNames;
public org.apache.lucene.analysis.Analyzer	getServiceAnalyzer() return Returns the serviceAnalyzer. return this.serviceAnalyzer;
public long	getWriteLockTimeout() return Returns the writeLockTimeout. return this.writeLockTimeout;
public int	hashCode() see java.lang.Object#hashCode() if (this.name == null) return super.hashCode(); return this.name.hashCode();
public void	initialize() Initialize the schema and checks all required values for (IndexSchemaField field : this.schemaFields) { if (!field.checkRequieredValues()) throw new RuntimeException("Required Value for field: " + field.getName() + " is missing"); } if (this.defaultSearchField == null) throw new RuntimeException("DefaulSearchField must not be null"); if (this.name == null) throw new RuntimeException( "Schema field is not set -- must not be null"); if (this.indexLocation == null) throw new RuntimeException("IndexLocation must not be null"); if(!this.searchableFieldNames.contains(this.defaultSearchField)){ throw new RuntimeException("the default search field: "+this.defaultSearchField+" is registered as a field"); }
public boolean	isUseCompoundFile() return Returns the useCompoundFile. return this.useCompoundFile;
public boolean	isUseTimedIndexer() return Returns the useTimedIndexer. return this.useTimedIndexer;
public void	setCommitAfterDocuments(int commitAfterDocuments) param commitAfterDocuments The commitAfterDocuments to set. if(commitAfterDocuments < DEFAULT_COMMIT_COUNT) return; this.commitAfterDocuments = commitAfterDocuments;
public void	setCommitLockTimeout(long commitLockTimeout) param commitLockTimeout The commitLockTimeout to set. // TODO enable this in config this.commitLockTimeout = commitLockTimeout;
public void	setDefaultSearchField(java.lang.String defaultField) param defaultField The defaultField to set. this.defaultSearchField = defaultField;
public void	setIndexLocation(java.lang.String indexLocation) param indexLocation The indexLocation to set. this.indexLocation = indexLocation;
public void	setIndexerIdleTime(long indexerIdleTime) param indexerIdleTime The indexerIdleTime to set. this.indexerIdleTime = indexerIdleTime;
public void	setMaxBufferedDocs(int maxBufferedDocs) param maxBufferedDocs The maxBufferedDocs to set. this.maxBufferedDocs = maxBufferedDocs;
public void	setMaxFieldLength(int maxFieldLength) param maxFieldLength The maxFieldLength to set. this.maxFieldLength = maxFieldLength;
public void	setMaxMergeDocs(int maxMergeDocs) param maxMergeDocs The maxMergeDocs to set. this.maxMergeDocs = maxMergeDocs;
public void	setMergeFactor(int mergeFactor) param mergeFactor The mergeFactor to set. this.mergeFactor = mergeFactor;
public void	setName(java.lang.String name) param name The name to set. this.name = name;
public void	setOptimizeAfterCommit(int optimizeAfterCommit) param optimizeAfterCommit The optimizeAfterCommit to set. if(optimizeAfterCommit < DEFAULT_OPTIMIZE_COUNT ) return; this.optimizeAfterCommit = optimizeAfterCommit;
public void	setSchemaFields(java.util.Collection fields) param fields The fieldConfiguration to set. this.schemaFields = fields;
public void	setServiceAnalyzer(org.apache.lucene.analysis.Analyzer serviceAnalyzer) param serviceAnalyzer The serviceAnalyzer to set. if (serviceAnalyzer == null) return; this.serviceAnalyzer = serviceAnalyzer;
public void	setUseCompoundFile(boolean useCompoundFile) param useCompoundFile The useCompoundFile to set. this.useCompoundFile = useCompoundFile;
public void	setUseTimedIndexer(boolean useTimedIndexer) param useTimedIndexer The useTimedIndexer to set. this.useTimedIndexer = useTimedIndexer;
public void	setWriteLockTimeout(long writeLockTimeout) param writeLockTimeout The writeLockTimeout to set. this.writeLockTimeout = writeLockTimeout;
public java.lang.String	toString() see java.lang.Object#toString() StringBuilder builder = new StringBuilder(this.getClass().getName()) .append(" "); builder.append("Name: ").append(this.name).append(" "); builder.append("MaxBufferedDocs: ").append(this.maxBufferedDocs) .append(" "); builder.append("MaxFieldLength: ").append(this.maxFieldLength).append( " "); builder.append("MaxMergeDocs: ").append(this.maxMergeDocs).append(" "); builder.append("MergeFactor: ").append(this.mergeFactor).append(" "); builder.append("CommitLockTimeout: ").append(this.commitLockTimeout) .append(" "); builder.append("WriteLockTimeout: ").append(this.writeLockTimeout) .append(" "); builder.append("indexerIdleTime: ").append(this.indexerIdleTime) .append(" "); builder.append("useCompoundFile: ").append(this.useCompoundFile) .append(" "); builder.append("Added SchemaField instances: ").append( this.schemaFields.size()).append(" "); builder.append("IndexLocation: ").append(this.indexLocation) .append(" "); return builder.toString();