cn.sowjz.souwen.v1

类 SouwenClient

java.lang.Object

cn.sowjz.souwen.v1.Base

cn.sowjz.souwen.v1.SouwenClient

public class SouwenClient
extends Base

字段概要

字段

限定符和类型	字段和说明
static String	Api_Version
static int	FEED_BUf_MAX_LEN
private ConnPool<IndexConn>	iconn_pool
static int	Once_Feed_Max_Table
static boolean	open_on_create
private ConnPool<QueryConn>	qconn_pool
static int	souwen_Version_Support

从类继承的字段 cn.sowjz.souwen.v1.Base

cfg, feedinfo, log, schema, sparser

构造器概要

构造器

限定符	构造器和说明
protected	SouwenClient()
	SouwenClient(SouwenConfig cfg) 构造方法

方法概要

限定符和类型	方法和说明
void	addDoc(Doc doc) 加载文章
void	addDoc(IndexConn conn, Doc doc)
void	addDoc(IndexConn conn, List<? extends Doc> docs)
void	addDoc(List<? extends Doc> docs) 加载文章
private void	checkNewSchema(Schema schema) 检测建库的字段
void	commit() 提交服务器端的内存数据到全文库 服务器端有缓存机制，加载的数据会先保存在服务器的缓存的中，直到缓存满了，服务器会自动地提交内存的数据到全文库。
void	commit(IndexConn conn)
long	count(QueryConn conn, QueryRequest request)
long	count(QueryRequest request) 通过条件统计总数 只返回统计结果的条数。
void	createDb(IndexConn conn, Schema schema)
void	createDb(Schema schema) 创建一个全文库
IndexConn	createIndexConn()
QueryConn	createQueryConn()
int	delDoc(QueryConn conn, QueryRequest request)
int	delDoc(QueryRequest request) 通过条件删除数据
Schema	descDb() 查询库结构
Schema	descDb(BaseConn conn)
void	destroy()
void	emptyDB()
void	emptyDB(IndexConn conn)
ExamineResponse	examine(QueryConn conn, QueryRequest request)
ExamineResponse	examine(QueryRequest request)
ConnPool<IndexConn>	getIndexConnPool()
ConnPool<QueryConn>	getQueryConnPool()
protected void	init_ConnPool(SouwenConfig cfg)
protected void	open() 打开全文检索系统，如果存在会得到全文库的配置结构
QueryResponse	query(QueryConn conn, QueryRequest request)
QueryResponse	query(QueryRequest request) 通过检索条件进行检索 如果只是要统计能够检索到多少条记录。
ServerIdxThreadStates	queryServerAddState() 测试服务器加载线程的状态。
ServerIdxThreadStates	queryServerAddState(QueryConn conn)
protected void	readFeedInfo(BaseConn conn)
void	releaseIndexConn(IndexConn conn)
void	releaseQueryConn(QueryConn conn)
void	stopServer() 停止服务器的运行。
void	testServerConnection() 测试服务器的连接状况
void	testServerConnection(BaseConn conn)
List<XWord>	tokenText(QueryConn conn, String text)
List<XWord>	tokenText(String text)
UpdateResponse	update(long seq_value_of_doc, Doc doc)
UpdateResponse	update(QueryConn conn, long seq_value_of_doc, Doc doc)
UpdateResponse	update(QueryConn conn, UpdateRequest request, Doc doc)
UpdateResponse	update(UpdateRequest req, Doc doc)

从类继承的方法 cn.sowjz.souwen.v1.Base

getCfg, getCharset, getFieldEnumId, getFieldEnumName, getSchema, getSpecialIdxParser, setSpecialIdxParser

从类继承的方法 java.lang.Object

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

字段详细资料

open_on_create

public static boolean open_on_create

Api_Version

public static final String Api_Version

另请参阅:

常量字段值

souwen_Version_Support

public static final int souwen_Version_Support

另请参阅:

常量字段值

Once_Feed_Max_Table

public static final int Once_Feed_Max_Table

另请参阅:

常量字段值

qconn_pool

private ConnPool<QueryConn> qconn_pool

iconn_pool

private ConnPool<IndexConn> iconn_pool

FEED_BUf_MAX_LEN

public static int FEED_BUf_MAX_LEN

构造器详细资料

SouwenClient

public SouwenClient(SouwenConfig cfg)
             throws Exception

构造方法

参数:

cfg - -- 配置信息

抛出:

SysConnectionException

Exception

SouwenClient

protected SouwenClient()

方法详细资料

init_ConnPool

protected void init_ConnPool(SouwenConfig cfg)
                      throws Exception

抛出:

Exception

open

protected void open()
             throws Exception

打开全文检索系统，如果存在会得到全文库的配置结构

抛出:

SysConnectionException - -- 当网络不通时会抛出该异常

Exception

readFeedInfo

protected void readFeedInfo(BaseConn conn)
                     throws Exception

抛出:

Exception

testServerConnection

public void testServerConnection()
                          throws Exception

测试服务器的连接状况

抛出:

Exception

testServerConnection

public void testServerConnection(BaseConn conn)
                          throws Exception

覆盖:

testServerConnection 在类中 Base

抛出:

Exception

queryServerAddState

public ServerIdxThreadStates queryServerAddState()
                                          throws Exception

测试服务器加载线程的状态。

返回:

-- 服务器的加载情况

抛出:

Exception

queryServerAddState

public ServerIdxThreadStates queryServerAddState(QueryConn conn)
                                          throws Exception

抛出:

Exception

descDb

public Schema descDb()
              throws Exception

查询库结构

返回:

-- 返回全文库结构

抛出:

Exception

descDb

public Schema descDb(BaseConn conn)
              throws Exception

抛出:

Exception

createDb

public void createDb(Schema schema)
              throws Exception

创建一个全文库

参数:

schema - -- 要创建的全文库的结构

抛出:

Exception

createDb

public void createDb(IndexConn conn,
                     Schema schema)
              throws Exception

抛出:

Exception

checkNewSchema

private void checkNewSchema(Schema schema)
                     throws Exception

检测建库的字段

参数:

schema -

抛出:

Exception

addDoc

public void addDoc(Doc doc)
            throws Exception

加载文章

参数:

doc - -- 要加载的文章

抛出:

Exception

addDoc

public void addDoc(IndexConn conn,
                   Doc doc)
            throws Exception

抛出:

Exception

addDoc

public void addDoc(List<? extends Doc> docs)
            throws Exception

加载文章

参数:

docs - -- 要加载的文章的集合

抛出:

Exception

addDoc

public void addDoc(IndexConn conn,
                   List<? extends Doc> docs)
            throws Exception

抛出:

Exception

query

public QueryResponse query(QueryRequest request)
                    throws Exception

通过检索条件进行检索

如果只是要统计能够检索到多少条记录。请使用SearchSystem.count(request)

参数:

request - -- 检索的条件

返回:

-- 检索结果集

抛出:

Exception

query

public QueryResponse query(QueryConn conn,
                           QueryRequest request)
                    throws Exception

抛出:

Exception

count

public long count(QueryRequest request)
           throws Exception

通过条件统计总数

只返回统计结果的条数。内容不返回。如果需要检索内容，使用SearchSystem.query(request)

参数:

request - -- 条件

返回:

-- 统计的总数

抛出:

Exception

count

public long count(QueryConn conn,
                  QueryRequest request)
           throws Exception

抛出:

Exception

delDoc

public int delDoc(QueryRequest request)
           throws Exception

通过条件删除数据

参数:

request - -- 要删除的条件

返回:

-- 删除的条数

抛出:

Exception

delDoc

public int delDoc(QueryConn conn,
                  QueryRequest request)
           throws Exception

抛出:

Exception

commit

public void commit()
            throws Exception

提交服务器端的内存数据到全文库

服务器端有缓存机制，加载的数据会先保存在服务器的缓存的中，直到缓存满了，服务器会自动地提交内存的数据到全文库。调用这个方法，如果服务器缓存中有数据，它会强制提交内存的数据到全文库，而不管缓存是否满了。

抛出:

Exception

commit

public void commit(IndexConn conn)
            throws Exception

抛出:

Exception

stopServer

public void stopServer()
                throws Exception

停止服务器的运行。

抛出:

Exception

emptyDB

public void emptyDB()
             throws Exception

抛出:

Exception

emptyDB

public void emptyDB(IndexConn conn)
             throws Exception

抛出:

Exception

tokenText

public List<XWord> tokenText(String text)
                      throws Exception

抛出:

Exception

tokenText

public List<XWord> tokenText(QueryConn conn,
                             String text)
                      throws Exception

抛出:

Exception

destroy

public void destroy()

createIndexConn

public IndexConn createIndexConn()
                          throws Exception

抛出:

Exception

releaseIndexConn

public void releaseIndexConn(IndexConn conn)
                      throws Exception

抛出:

Exception

createQueryConn

public QueryConn createQueryConn()
                          throws Exception

抛出:

Exception

releaseQueryConn

public void releaseQueryConn(QueryConn conn)
                      throws Exception

抛出:

Exception

getQueryConnPool

public ConnPool<QueryConn> getQueryConnPool()

getIndexConnPool

public ConnPool<IndexConn> getIndexConnPool()

update

public UpdateResponse update(UpdateRequest req,
                             Doc doc)
                      throws Exception

抛出:

Exception

update

public UpdateResponse update(QueryConn conn,
                             UpdateRequest request,
                             Doc doc)
                      throws Exception

抛出:

Exception

update

public UpdateResponse update(long seq_value_of_doc,
                             Doc doc)
                      throws Exception

抛出:

Exception

update

public UpdateResponse update(QueryConn conn,
                             long seq_value_of_doc,
                             Doc doc)
                      throws Exception

抛出:

Exception

examine

public ExamineResponse examine(QueryRequest request)
                        throws Exception

抛出:

Exception

examine

public ExamineResponse examine(QueryConn conn,
                               QueryRequest request)
                        throws Exception

抛出:

Exception