net.gdface.sdk.fse.thrift

Class FeatureSeThriftClient

java.lang.Object

net.gdface.sdk.fse.thrift.FeatureSeThriftClient

All Implemented Interfaces:

FeatureSe

public class FeatureSeThriftClient
extends java.lang.Object
implements FeatureSe

基于thrift/swift框架生成的client端代码提供FeatureSe接口的RPC实现(线程安全)
转发所有FeatureSe接口方法到delegate()指定的实例
所有服务端抛出的RuntimeException异常被封装到ServiceRuntimeException中抛出
Example:

        FeatureSeThriftClient thriftInstance = ClientFactory
            .builder()
            .setHostAndPort("127.0.0.1",26413)
            .build(FeatureSe.class, FeatureSeThriftClient.class);
 

计算机生成代码(generated by automated tools ThriftServiceDecoratorGenerator @author guyadong)

Author:

guyadong

Constructor Summary

Constructors

Constructor and Description
FeatureSeThriftClient(net.gdface.thrift.ClientFactory factory)
FeatureSeThriftClient(com.google.common.net.HostAndPort hostAndPort)
FeatureSeThriftClient(java.lang.String host, int port)

Method Summary

Modifier and Type	Method and Description
boolean	addFeature(byte[] featureId, byte[] feature, long appid) 添加一条特征码到内存表
boolean	addFeature(byte[] featureId, byte[] feature, java.lang.String imgMD5) 添加一条特征码到内存表
void	clearAll() 删除内存表中所有特征数据
protected FeatureSe	delegate()
net.gdface.thrift.ClientFactory	getFactory()
CodeBean	getFeature(byte[] featureId) 根据特征码ID在表中查找指定的记录
CodeBean	getFeatureByHex(java.lang.String featureId) 根据特征码ID在表中查找指定的记录
boolean	removeFeature(byte[] featureId) 根据特征码ID中表中删除指定的记录
boolean	removeFeatureByHex(java.lang.String featureId) 根据特征码ID中表中删除指定的记录
CodeBean[]	searchCode(byte[] code, double sim, int rows) 在内存表中根据比对相似度进行特征码搜索
int	size()
boolean	testConnect() test if connectable for RPC service
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FeatureSeThriftClient

public FeatureSeThriftClient(net.gdface.thrift.ClientFactory factory)

FeatureSeThriftClient

public FeatureSeThriftClient(java.lang.String host,
                             int port)

Parameters:

host - RPC service host

port - RPC service port

FeatureSeThriftClient

public FeatureSeThriftClient(com.google.common.net.HostAndPort hostAndPort)

Parameters:

hostAndPort - RPC service host and port

Method Detail

getFactory

public net.gdface.thrift.ClientFactory getFactory()

testConnect

public boolean testConnect()

test if connectable for RPC service

Returns:

return true if connectable ,otherwise false

delegate

protected FeatureSe delegate()

Returns:

返回FeatureSe实例

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

addFeature

public boolean addFeature(byte[] featureId,
                          byte[] feature,
                          java.lang.String imgMD5)

Description copied from interface: FeatureSe

添加一条特征码到内存表

Specified by:

addFeature in interface FeatureSe

Parameters:

featureId - 特征码ID(MD5校验码),为null时,native library会自动计算MD5作为特征码ID

feature - 特征码字节数组,为null时返回false

imgMD5 - 特征所属图的MD5(32字节HEX字符串),可为null

Returns:

添加成功返回true, 否则返回false

addFeature

public boolean addFeature(byte[] featureId,
                          byte[] feature,
                          long appid)

Description copied from interface: FeatureSe

添加一条特征码到内存表

Specified by:

addFeature in interface FeatureSe

Parameters:

featureId - 特征码ID(MD5校验码),为null时,native library会自动计算MD5作为特征码ID

feature - 特征码字节数组,为null时返回false

appid - 应用id,由调用者定义,可为null

Returns:

添加成功返回true, 否则返回false

clearAll

public void clearAll()

Description copied from interface: FeatureSe

删除内存表中所有特征数据

Specified by:

clearAll in interface FeatureSe

getFeature

public CodeBean getFeature(byte[] featureId)

Description copied from interface: FeatureSe

根据特征码ID在表中查找指定的记录

Specified by:

getFeature in interface FeatureSe

Parameters:

featureId - 特征码ID,MD5校验码(16 bytes)

Returns:

返回指定的特征记录,没有找到则返回null,featureId为null或空返回null

getFeatureByHex

public CodeBean getFeatureByHex(java.lang.String featureId)

Description copied from interface: FeatureSe

根据特征码ID在表中查找指定的记录

Specified by:

getFeatureByHex in interface FeatureSe

Parameters:

featureId - 特征码ID,MD5校验码(32字节HEX字符串)

Returns:

返回指定的特征记录,没有找到则返回null,featureId为null或空返回null

removeFeature

public boolean removeFeature(byte[] featureId)

Description copied from interface: FeatureSe

根据特征码ID中表中删除指定的记录

Specified by:

removeFeature in interface FeatureSe

Parameters:

featureId - 特征码ID,MD5校验码(16 bytes)

Returns:

成功删除则返回true,否则返回false

removeFeatureByHex

public boolean removeFeatureByHex(java.lang.String featureId)

Description copied from interface: FeatureSe

根据特征码ID中表中删除指定的记录

Specified by:

removeFeatureByHex in interface FeatureSe

Parameters:

featureId - 特征码ID,MD5校验码(32字节HEX字符串)

Returns:

成功删除则返回true,否则返回false

searchCode

public CodeBean[] searchCode(byte[] code,
                             double sim,
                             int rows)

Description copied from interface: FeatureSe

在内存表中根据比对相似度进行特征码搜索

Specified by:

searchCode in interface FeatureSe

Parameters:

code - 要比对的特征码

sim - 相似度阀值

rows - 最大返回的记录数

Returns:

返回包含相似度(降序)的结果数组,如果没有查到匹配的记录则返回空数组

size

public int size()

Specified by:

size in interface FeatureSe

Returns:

内存表中元素个数