一个简单的COMPASS应用

一个简单的COMPASS应用

首先你要下载Compass framework: Download Compass.
你需要在你的class path 中添加4个jar compass-x/modules/core/compass-core-x.jar, compass/modules/core/lib/commons-logging-x.jar, compass-x/modules/core/lib/log4j-x.jar, compass-x/modules/core/lib/lucene-core-x-rc1-dev.jar.
在你的项目中创建下面的目录(可以根据自己的定义来改动)：
log4j.properties
- org
   - compassframework
     - sample
       - example
           alias.cmd.xml
           compass.cfg.xml
           CompassExample.java
           Phrase.cpm.xml
           Phrase.java
下面说一下几个重要的配置文件

 compass.cfg.xmlcode

指定的target/index 是一个存储目录放索引文件的

（这个类必须有个无参数的构造和id属性）

xml 代码

2.   
3.   
4. "http://static.compassframework.org/dtd/compass-core-configuration-1.0.dtd">    
5.   
6.   
7.   
8. <  
9.   
10. compass-core-configuration>    
11. <compass>  
12.   
13. <setting name="compass.engine.connection">target/indexsetting>  
14.   
15. <meta-data resource="org/compassframework/sample/example/alias.cmd.xml" />  
16.   
17. compass>  
18.   
19. compass-core-configuration>  
20.   

 alias.cmd.xml:

xml 代码

1.   
2.   
3. xml version="1.0"?>    
5. "-//Compass/Compass Core Meta Data DTD 1.0//EN"    
6. "http://static.compassframework.org/dtd/compass-core-meta-data-1.0.dtd">    
7. <compass-core-meta-data>    
8. <meta-data-group id="example" displayName="Example Meta Data">  
9.   
10. <description>Example Meta Datadescription>  
11.   
12. <uri>http://compass/exampleuri>  
13.   
14.   
15. <alias id="phrase" displayName="Phrase">  
16.   
17. <description>Phrase aliasdescription>  
18.   
19. <uri>http://compass/example/phraseuri>  
20.   
21. <name>phrasename>  
22.   
23. alias>  
24.   
25. <meta-data id="author" displayName="Author">  
26.   
27. <description>Author aliasdescription>  
28.   
29. <uri>http://compass/example/authoruri>  
30.   
31. <name>authorname>  
32.   
33. meta-data>  
34.   
35. <meta-data id="text" displayName="Text">  
36.   
37. <description>Text aliasdescription>  
38.   
39. <uri>http://compass/example/texturi>  
40.   
41. <name>textname>  
42.   
43. meta-data>  
44.   
45. meta-data-group>  
46.   
47. compass-core-meta-data>  

Phrase.java

java 代码

1. package org.compassframework.sample.example;   
2.   
3. public class Phrase {   
4.   
5.  private String author;   
6.   
7.  private String text;   
8.   
9.  private Long id;   
10.   
11.  public Phrase() {   
12.   
13.  }   
14.   
15.  public String getAuthor() {   
16.      return author;   
17.  }   
18.   
19.  public void setAuthor(String author) {   
20.      this.author = author;   
21.  }   
22.   
23.  public String getText() {   
24.      return text;   
25.  }   
26.   
27.  public void setText(String text) {   
28.      this.text = text;   
29.  }   
30.   
31.  public Long getId() {   
32.      return id;   
33.  }   
34.   
35.  public void setId(Long id) {   
36.      this.id = id;   
37.  }   
38.   
39.  public String toString() {   
40.   
41.      return text;   
42.  }   
43.   
44. }    

Phrase.cpm.xml


 

xml 代码

xml version="1.0"?>     "-//Compass/Compass Core Mapping DTD 1.0//EN"     "http://static.compassframework.org/dtd/compass-core-mapping-1.0.dtd">     <compass-core-mapping package="org.compassframework.sample.example">     <class name="Phrase" alias="${example.phrase}">      <id name="id" />      <property name="author">      <meta-data>${example.author}meta-data>      property>      <property name="text">      <meta-data>${example.text}meta-data>      property>      class>      compass-core-mapping>  

CompassExample.java


java 代码

package org.compassframework.sample.example;       import org.apache.log4j.Logger;       import org.compassframework.core.Compass;    import org.compassframework.core.Compass;    import org.compassframework.core.CompassSession;    import org.compassframework.core.CompassTransaction;    import org.compassframework.core.config.CompassConfiguration;       public class CompassExample {        private static final Logger logger = Logger.getLogger(CompassExample.class);          private compasscompass;          public static void main(String[] args){         new CompassExample().process();     }          private void process(){         CompassConfiguration config = new CompassConfiguration();         config.configure("org/compassframework/sample/example/compass.cfg.xml");         config.addClass(Phrase.class);         compass = config.buildCompass();         compass.getSearchEngineIndexManager().deleteIndex();         compass.getSearchEngineIndexManager().createIndex();               createIndex();         search("mule AND crazy");         search("Marisol OR Ramon");     }          private void createIndex(){      CompassSession session = compass.openSession();         CompassTransaction tx = session.beginTransaction();         Phrase phrase = new Phrase();         phrase.setAuthor("Joe");         phrase.setText("I don't think it's nice you laughing. " +                 "You see my mule don't like people laughing. " +                 "He gets the crazy idea you're laughing at him. " +                 "Now if you apologize like I know you're going to, " +                 "I might convince him that you really didn't mean it...");         phrase.setId(new Long(1));         session.save(phrase);         tx.commit();         session.close();     }          private void search(String query){         CompassSession session = compass.openSession();         CompassTransaction tx = session.beginTransaction();         Compass hits = session.find(query);         if (logger.isDebugEnabled()) {            logger.debug("search() - Found " + hits.getLength()+" hits for \""+query+"\"");         }         for (int i = 0; i < hits.getLength(); i++) {            print(hits, i);         }         hits.close();         tx.commit();         session.close();         compass.close();     }          private void print(Compass hits, int hitNumber) {         Phrase value = (Phrase)hits.data(hitNumber);         if (logger.isDebugEnabled()) {             logger.debug("print() - Phrase by " + value.getAuthor() + ": "                + value.getText());         }     }       }      

 

为了保证能打印出我们的测试，需要加入log4j.properties ：
log4j.rootLogger=ERROR, stdout
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout log4j.appender.stdout.layout.ConversionPattern=%d %p %c - %m%n
log4j.logger.org.compassframework.sample.example=DEBUG

下面是打印出来的测试结果：
search() - Found 1 hits for "mule AND crazy"
print() - Phrase by Joe: I don't think it's nice you laughing...
search() - Found 0 hits for "Marisol OR Ramon"