oracle.ultrasearch.crawler
Interface UrlData

public interface UrlData

UrlData is an interface used by a crawler agent to submit URL-related data to the crawler.

Field Summary

static int	ACCESS_URL Access URL property of a document
static int	ATTR_DATE Date attribute data type
static int	ATTR_NUMBER Number attribute data type
static int	ATTR_STRING String attribute data type
static int	DELETED Delete flag
static int	DISPLAY_URL Display URL property of a document
static int	DOC_KEY Document key of a document
static java.lang.String	FALSE Property value is false
static int	LANGUAGE Language of a document
static int	PARSE_DOC Parsing document for attribute value
static java.lang.String	TRUE Property value is true

Method Summary

void	addAttribute(java.lang.String name, java.math.BigDecimal value) Add an attribute value whose type is number
void	addAttribute(java.lang.String name, java.sql.Date value) Add an attribute value whose type is java.sql.Date
void	addAttribute(java.lang.String name, java.lang.String value) Add an attribute value whose type is string
void	clearData() Clear all URL data
java.lang.String	getAttributeName(int attrIndex) Get the name of the specified attribute
int	getAttributeType(int attrIndex) Get the data type of the specified attribute
java.util.Enumeration	getAttributeValues(int attrIndex) Get the list of values for a specified attribute
int	getNumAttributes() Get number of attributes
int	getNumAttrValues() Get number of attribute values
java.lang.String	getProperty(int name) Get the value of an URL data property
void	setProperty(int name, java.lang.String value) Set the value of a document property

Field Detail

DISPLAY_URL

public static final int DISPLAY_URL

Display URL property of a document

ACCESS_URL

public static final int ACCESS_URL

Access URL property of a document

DOC_KEY

public static final int DOC_KEY

Document key of a document

LANGUAGE

public static final int LANGUAGE

Language of a document

PARSE_DOC

public static final int PARSE_DOC

Parsing document for attribute value

DELETED

public static final int DELETED

Delete flag

ATTR_STRING

public static final int ATTR_STRING

String attribute data type

ATTR_NUMBER

public static final int ATTR_NUMBER

Number attribute data type

ATTR_DATE

public static final int ATTR_DATE

Date attribute data type

TRUE

public static final java.lang.String TRUE

Property value is true

FALSE

public static final java.lang.String FALSE

Property value is false

Method Detail

setProperty

public void setProperty(int name,
                        java.lang.String value)

Set the value of a document property

Parameters:

name - the name of the property

value - the value of the property

getProperty

public java.lang.String getProperty(int name)

Get the value of an URL data property

Parameters:

name - the name of the property

Returns:

the property value which can be null if there is no such property

addAttribute

public void addAttribute(java.lang.String name,
                         java.math.BigDecimal value)

Add an attribute value whose type is number

Parameters:

name - the name of the attribute

value - the value of the attribute

addAttribute

public void addAttribute(java.lang.String name,
                         java.sql.Date value)

Add an attribute value whose type is java.sql.Date

Parameters:

name - the name of the attribute

value - the value of the attribute

addAttribute

public void addAttribute(java.lang.String name,
                         java.lang.String value)

Add an attribute value whose type is string

Parameters:

name - the name of the attribute

value - the value of the attribute

getNumAttributes

public int getNumAttributes()

Get number of attributes

Returns:

number of attributes for this document

getNumAttrValues

public int getNumAttrValues()

Get number of attribute values

Returns:

number of attribute values for this document

getAttributeName

public java.lang.String getAttributeName(int attrIndex)

Get the name of the specified attribute

Parameters:

attrIndex - 0 based index indicating which attribute

Returns:

the name of the specified attribute

getAttributeType

public int getAttributeType(int attrIndex)

Get the data type of the specified attribute

Parameters:

attrIndex - 0 based index indicating which attribute

Returns:

the data type of the specified attribute: ATTR_INT, ATTR_STR, or ATTR_DATE.

getAttributeValues

public java.util.Enumeration getAttributeValues(int attrIndex)

Get the list of values for a specified attribute

Parameters:

attrIndex - 0 based index indicating which attribute

Returns:

an enumeration of objects containing attribute values

clearData

public void clearData()

Clear all URL data