bt_rlp_ne_types.h File Reference

Compatibility interface for Type codes for named entities. More...

#include <bt_types.h>
#include <bt_ne_types.h>

Include dependency graph for bt_rlp_ne_types.h:

This graph shows which files directly or indirectly include this file:


Defines

#define BT_RLP_NE_TYPE_FACILITY   BT_NE_TYPE_FACILITY
 Deprecated. See BT_NE_TYPE_FACILITY in bt_ne_types.h.
#define BT_RLP_NE_TYPE_GPE   BT_NE_TYPE_GPE
 Deprecated. See BT_NE_TYPE_GPE in bt_ne_types.h.
#define BT_RLP_NE_TYPE_IDENTIFIER   BT_NE_TYPE_IDENTIFIER
 Deprecated. See BT_NE_TYPE_IDENTIFIER in bt_ne_types.h.
#define BT_RLP_NE_TYPE_IDENTIFIER_CREDIT_CARD_NUM   BT_NE_TYPE_IDENTIFIER_CREDIT_CARD_NUM
 Deprecated. See BT_NE_TYPE_IDENTIFIER_CREDIT_CARD_NUM in bt_ne_types.h.
#define BT_RLP_NE_TYPE_IDENTIFIER_DISTANCE   BT_NE_TYPE_IDENTIFIER_DISTANCE
 Deprecated. See BT_NE_TYPE_IDENTIFIER_DISTANCE in bt_ne_types.h.
#define BT_RLP_NE_TYPE_IDENTIFIER_DOMAIN_NAME   BT_NE_TYPE_IDENTIFIER_DOMAIN_NAME
 Deprecated. See BT_NE_TYPE_IDENTIFIER_DOMAIN_NAME in bt_ne_types.h.
#define BT_RLP_NE_TYPE_IDENTIFIER_EMAIL   BT_NE_TYPE_IDENTIFIER_EMAIL
 Deprecated. See BT_NE_TYPE_IDENTIFIER_EMAIL in bt_ne_types.h.
#define BT_RLP_NE_TYPE_IDENTIFIER_FAX_NUMBER   BT_NE_TYPE_IDENTIFIER_FAX_NUMBER
 Deprecated. See BT_NE_TYPE_IDENTIFIER_FAX_NUMBER in bt_ne_types.h.
#define BT_RLP_NE_TYPE_IDENTIFIER_IP_ADDRESS   BT_NE_TYPE_IDENTIFIER_IP_ADDRESS
 Deprecated. See BT_NE_TYPE_IDENTIFIER_IP_ADDRESS in bt_ne_types.h.
#define BT_RLP_NE_TYPE_IDENTIFIER_LATITUDE_LONGITUDE   BT_NE_TYPE_IDENTIFIER_LATITUDE_LONGITUDE
 Deprecated. See BT_NE_TYPE_IDENTIFIER_LATITUDE_LONGITUDE in bt_ne_types.h.
#define BT_RLP_NE_TYPE_IDENTIFIER_MONEY   BT_NE_TYPE_IDENTIFIER_MONEY
 Deprecated. See BT_NE_TYPE_IDENTIFIER_MONEY in bt_ne_types.h.
#define BT_RLP_NE_TYPE_IDENTIFIER_NUMBER   BT_NE_TYPE_IDENTIFIER_NUMBER
 Deprecated. See BT_NE_TYPE_IDENTIFIER_NUMBER in bt_ne_types.h.
#define BT_RLP_NE_TYPE_IDENTIFIER_PERCENT   BT_NE_TYPE_IDENTIFIER_PERCENT
 Deprecated. See BT_NE_TYPE_IDENTIFIER_PERCENT in bt_ne_types.h.
#define BT_RLP_NE_TYPE_IDENTIFIER_PERSONAL_ID_NUM   BT_NE_TYPE_IDENTIFIER_PERSONAL_ID_NUM
 Deprecated. See BT_NE_TYPE_IDENTIFIER_PERSONAL_ID_NUM in bt_ne_types.h.
#define BT_RLP_NE_TYPE_IDENTIFIER_PHONE_NUMBER   BT_NE_TYPE_IDENTIFIER_PHONE_NUMBER
 Deprecated. See BT_NE_TYPE_IDENTIFIER_PHONE_NUMBER in bt_ne_types.h.
#define BT_RLP_NE_TYPE_IDENTIFIER_URL   BT_NE_TYPE_IDENTIFIER_URL
 Deprecated. See BT_NE_TYPE_IDENTIFIER_URL in bt_ne_types.h.
#define BT_RLP_NE_TYPE_IDENTIFIER_UTM   BT_NE_TYPE_IDENTIFIER_UTM
 Deprecated. See BT_NE_TYPE_IDENTIFIER_UTM in bt_ne_types.h.
#define BT_RLP_NE_TYPE_LOCATION   BT_NE_TYPE_LOCATION
 Deprecated. See BT_NE_TYPE_LOCATION in bt_ne_types.h.
#define BT_RLP_NE_TYPE_NATIONALITY   BT_NE_TYPE_NATIONALITY
 Deprecated. See BT_NE_TYPE_NATIONALITY in bt_ne_types.h.
#define BT_RLP_NE_TYPE_NONE   BT_NE_TYPE_NONE
 Deprecated. See BT_NE_TYPE_NONE in bt_ne_types.h.
#define BT_RLP_NE_TYPE_ORGANIZATION   BT_NE_TYPE_ORGANIZATION
 Deprecated. See BT_NE_TYPE_ORGANIZATION in bt_ne_types.h.
#define BT_RLP_NE_TYPE_PERSON   BT_NE_TYPE_PERSON
 Deprecated. See BT_NE_TYPE_PERSON in bt_ne_types.h.
#define BT_RLP_NE_TYPE_RELIGION   BT_NE_TYPE_RELIGION
 Deprecated. See BT_NE_TYPE_RELIGION in bt_ne_types.h.
#define BT_RLP_NE_TYPE_TEMPORAL   BT_NE_TYPE_TEMPORAL
 Deprecated. See BT_NE_TYPE_TEMPORAL in bt_ne_types.h.
#define BT_RLP_NE_TYPE_TEMPORAL_DATE   BT_NE_TYPE_TEMPORAL_DATE
 Deprecated. See BT_NE_TYPE_TEMPORAL_DATE in bt_ne_types.h.
#define BT_RLP_NE_TYPE_TEMPORAL_TIME   BT_NE_TYPE_TEMPORAL_TIME
 Deprecated. See BT_NE_TYPE_TEMPORAL_TIME in bt_ne_types.h.
#define BT_RLP_NE_TYPE_TITLE   BT_NE_TYPE_TITLE
 Deprecated. See BT_NE_TYPE_TITLE in bt_ne_types.h.
#define BT_RLP_NE_TYPE_VEHICLE   BT_NE_TYPE_VEHICLE
 Deprecated. See BT_NE_TYPE_VEHICLE in bt_ne_types.h.
#define BT_RLP_NE_TYPE_WEAPON   BT_NE_TYPE_WEAPON
 Deprecated. See BT_NE_TYPE_WEAPON in bt_ne_types.h.

Functions

BT_UInt32 BT_RLP_GET_NETYPE_SOURCE_ID (BT_UInt32 id)
 Gets the id of the language processor that generated the NE Tag.
BT_UInt32 BT_RLP_GET_SOURCE_ID (const char *name)
 Gets the id of the language processor that generated the NE Tag.
const char * BT_RLP_GET_SOURCE_NAME (size_t id)
 Gets the name of a named entity language processor.
BT_UInt32 BT_RLP_NET_GET_WEIGHT (BT_UInt32 id)
 Retrieves the weighting of the type-source tag combo, as defined in ne-types.xml.
const char * BT_RLP_NET_ID_TO_STRING (BT_UInt32 id)
 Map an RLP named entity type into a string form.
BT_UInt32 BT_RLP_NET_STRING_TO_ID (const char *name)
 Map an RLP named entity type string into its integer code.

Detailed Description

This file provides backward compatibility for applications written before RLP 5.0, where named entity types are with names including "RLP_".

This also provides an interface to the custom named entity type static methods.


Function Documentation

BT_UInt32 BT_RLP_GET_NETYPE_SOURCE_ID ( BT_UInt32  id  ) 

Parameters:
id the named entity id
Returns:
ne language processor id

BT_UInt32 BT_RLP_GET_SOURCE_ID ( const char *  name  ) 

Parameters:
name the name of the ne language processor
Returns:
ne language processor id

const char* BT_RLP_GET_SOURCE_NAME ( size_t  id  ) 

This function gets the name of a named entity langauge processor. NB: Use BT_RLP_GET_NETYPE_SOURCE_ID(BT_UInt32 id) to get the input id for this funtion based on the named entity id generated by RLP.

Parameters:
id language processor id
Returns:
name of ne language processor

const char* BT_RLP_NET_ID_TO_STRING ( BT_UInt32  id  ) 

This function maps an RLP entity type to its string equivalent. This function should be called only after a BT_RLP_Context has been initialized. The returned pointer is valid only for the duration of the context.

Both built-in types (see BT_NE_Type_To_String in utiltities/bt_ne_types.h) and dynamic types (such as gazetteer names) are handled. The encoding of the returned data is UTF-8.

Parameters:
id Entity type.
Returns:
Constant string value for the entity type.

BT_UInt32 BT_RLP_NET_STRING_TO_ID ( const char *  name  ) 

This function converts an RLP entity type from a string into an integer code. This function should be called only after a BT_RLP_Context has been initialized.

Both built-in types (see BT_NE_String_To_Type in utilities/bt_ne_types.h) and dynamic types (such as gazetteer names) are handled. The input string should be encoded in UTF-8.

Parameters:
name the string value for the type, in the format Major:Minor
Returns:
Entity type


Copyright © 2004-2008 Basis Technology Corporation. All Rights Reserved.