This project has retired. For details please refer to its Attic page.

org.apache.cocoon.components.search
Class IndexStructure

java.lang.Object
  org.apache.cocoon.components.search.IndexStructure

public final class IndexStructure
extends java.lang.Object

Index Definition class, contain all the index field definitions.

Author:

Nicolas Maisonneuve

Constructor Summary

IndexStructure()

Method Summary

void	addFieldDef(FieldDefinition fielddef) add a fieldDefiniition to the indexDefinition
FieldDefinition[]	getFieldDef() return all fieldDefinitions
FieldDefinition	getFieldDef(java.lang.String fieldname) Return the fieldDefinition associated to the name
java.lang.String[]	getFieldNames()
boolean	hasField(java.lang.String name) check if this field exist
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IndexStructure

public IndexStructure()

Method Detail

addFieldDef

public void addFieldDef(FieldDefinition fielddef)

add a fieldDefiniition to the indexDefinition

Parameters:

fielddef -

getFieldNames

public final java.lang.String[] getFieldNames()

Returns:

all fieldnames contained in the index

getFieldDef

public final FieldDefinition[] getFieldDef()

return all fieldDefinitions

Returns:

FieldDefinition[]

getFieldDef

public final FieldDefinition getFieldDef(java.lang.String fieldname)

Return the fieldDefinition associated to the name

Parameters:

fieldname - String the name of the fieldDefiniation

Returns:

FieldDefinition

hasField

public final boolean hasField(java.lang.String name)

check if this field exist

Parameters:

name - the field's name

Returns:

true if a field with this name exist

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object