net.sf.mmapps.modules.lucenesearch
Class SourceTable

java.lang.Object
  extended bynet.sf.mmapps.modules.lucenesearch.SourceTable

public class SourceTable
extends java.lang.Object

Represents a Table (aka Builder) in MMBase and it's fields and relations

Version:
$Revision: 1.1 $
Author:
Wouter Heijke

Constructor Summary
SourceTable()
           
 
Method Summary
 void addField(DataField field)
          Add a field from this table
 void addRelated(DataRelation relation)
          Add a related table
protected  void collectAll(org.mmbase.bridge.Cloud cloud, IndexHelper writer)
          Collect all nodes in the table this object represents
 void collectOne(org.mmbase.bridge.Node node, IndexHelper writer)
          Collect and index a single MMBase Node
 java.util.Collection getAllFields()
           
 java.util.List getFields()
           
 java.lang.String getName()
          Get's the name of the MMBase builder/table this object represents
 java.util.List getRelated()
           
 void setName(java.lang.String newName)
          Set's the name of the MMBase builder/table this object represents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SourceTable

public SourceTable()
Method Detail

collectAll

protected void collectAll(org.mmbase.bridge.Cloud cloud,
                          IndexHelper writer)
Collect all nodes in the table this object represents

Parameters:
cloud - MMBase cloud to use for indexing
writer - Lucene document writer

collectOne

public void collectOne(org.mmbase.bridge.Node node,
                       IndexHelper writer)
Collect and index a single MMBase Node

Parameters:
node - MMBase node to index
writer - Lucene writer to use for indexing this node

setName

public void setName(java.lang.String newName)
Set's the name of the MMBase builder/table this object represents

Parameters:
newName - Name of the builder/table

getName

public java.lang.String getName()
Get's the name of the MMBase builder/table this object represents

Returns:
name The name

addField

public void addField(DataField field)
Add a field from this table

Parameters:
field - Field object representing information about the field

getFields

public java.util.List getFields()
Returns:
list of fields

getAllFields

public java.util.Collection getAllFields()
Returns:
collection of fields and fields of related elements

addRelated

public void addRelated(DataRelation relation)
Add a related table

Parameters:
relation - DataRelation object holding the information on the related table

getRelated

public java.util.List getRelated()
Returns:
list of related elements


Copyright © 2003-2005 mmapps. All Rights Reserved.