com.google.enterprise.connector.spi

Class Value

java.lang.Object

com.google.enterprise.connector.spi.Value

public abstract class Value
extends java.lang.Object

Wrapper class for all data items from a repository. Connector implementors create instances of this class by calling the appropriate static factory method. The factory methods are named to reflect the type data they carry, thus:

• getStringValue creates an object carrying a string
• getBinaryValue creates an object carrying binary data (stream or byte array)
• getLongValue creates an object carrying an integer
• getDoubleValue creates an object carrying a floating-point value
• getDateValue creates an object carrying a date
• getBooleanValue creates an object carrying a boolean

In addition, some of the factory methods are overloaded for the convenience of the connector developer. The implementations attempt to convert from the parameter type to the base type indicated in the factory method's name.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
Value()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	calendarToFeedXml(java.util.Calendar calendar) Formats a calendar object for the Feeds Protocol, using the ISO-8601 format for just the date portion.
static java.lang.String	calendarToIso8601(java.util.Calendar calendar) Formats a calendar object according to the ISO-8601 specification.
static java.lang.String	calendarToRfc822(java.util.Calendar calendar) Formats a calendar object according to the RFC 822 specification.
static Value	getBinaryValue(byte[] byteArrayValue) Creates a value carrying binary data.
static Value	getBinaryValue(java.io.InputStream inputStreamValue) Creates a value carrying binary data.
static Value	getBinaryValue(InputStreamFactory inputStreamFactory) Creates a value carrying binary data.
static Value	getBooleanValue(boolean booleanValue) Creates a value carrying a boolean.
static Value	getBooleanValue(java.lang.String stringValue) Creates a value carrying a boolean.
static Value	getDateValue(java.util.Calendar calendarValue) Creates a value carrying a date.
static Value	getDoubleValue(double doubleValue) Creates a value carrying an integer.
static Value	getLongValue(long longValue) Creates a value carrying an integer.
static Value	getPrincipalValue(Principal principal) Creates a value carrying a principal.
static Value	getPrincipalValue(java.lang.String name) Creates a value carrying a principal.
static Value	getSingleValue(Document document, java.lang.String propertyName) Convenience function for access to a single named value from a Document.
static java.lang.String	getSingleValueString(Document document, java.lang.String propertyName) Convenience function for access to a single string value from a Document.
static Value	getStringValue(java.lang.String stringValue) Creates a value carrying a String.
static java.util.Calendar	iso8601ToCalendar(java.lang.String dateString) Parses a String in ISO-8601 format (GMT zone) and returns an equivalent java.util.Calendar object.
static void	setFeedTimeZone(java.lang.String id) Sets the time zone used to format date values for the feed to the given time zone.
abstract java.lang.String	toString() Returns a string representation of the Value.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Value

public Value()

Method Detail

getStringValue

public static Value getStringValue(java.lang.String stringValue)

Creates a value carrying a String.

Parameters:

stringValue - the String value

Returns:

a Value instance carrying this value

getBinaryValue

public static Value getBinaryValue(java.io.InputStream inputStreamValue)

Creates a value carrying binary data.

Parameters:

inputStreamValue - an InputStream containing the data

Returns:

a Value instance carrying this data

getBinaryValue

public static Value getBinaryValue(InputStreamFactory inputStreamFactory)

Creates a value carrying binary data.

Parameters:

inputStreamFactory - an InputStreamFactory

Returns:

a Value instance carrying this data

getBinaryValue

public static Value getBinaryValue(byte[] byteArrayValue)

Creates a value carrying binary data.

Parameters:

byteArrayValue - an byte array containing the data

Returns:

a Value instance carrying this data

getLongValue

public static Value getLongValue(long longValue)

Creates a value carrying an integer.

Parameters:

longValue - a long containing the data

Returns:

a Value instance carrying this data

getDoubleValue

public static Value getDoubleValue(double doubleValue)

Creates a value carrying an integer.

Parameters:

doubleValue - a double containing the data

Returns:

a Value instance carrying this data

getDateValue

public static Value getDateValue(java.util.Calendar calendarValue)

Creates a value carrying a date.

Parameters:

calendarValue - a Calendar object containing the data

Returns:

a Value instance carrying this data

getBooleanValue

public static Value getBooleanValue(boolean booleanValue)

Creates a value carrying a boolean.

Parameters:

booleanValue - a boolean containing the data

Returns:

a Value instance carrying this data

getBooleanValue

public static Value getBooleanValue(java.lang.String stringValue)

Creates a value carrying a boolean.

Parameters:

stringValue - A String containing the data. The String is converted as follows:

• Any case variant of the strings "f" and "false" return false.
• All other strings (including null and the empty string) return true.

Returns:

a Value instance carrying this data

getPrincipalValue

public static Value getPrincipalValue(java.lang.String name)

Creates a value carrying a principal.

Parameters:

name - a String representing the name of a principal.

getPrincipalValue

public static Value getPrincipalValue(Principal principal)

Creates a value carrying a principal.

Parameters:

principal - a Principal

getSingleValue

public static Value getSingleValue(Document document,
                                   java.lang.String propertyName)
                            throws RepositoryException

Convenience function for access to a single named value from a Document.

Parameters:

document - the Document from which to extract the Value

propertyName - the name of the Property

Returns:

the first Value of that named property, if there is one - null otherwise

Throws:

RepositoryException

getSingleValueString

public static java.lang.String getSingleValueString(Document document,
                                                    java.lang.String propertyName)
                                             throws RepositoryException

Convenience function for access to a single string value from a Document.

Parameters:

document - the Document from which to extract the Value

propertyName - the name of the Property

Returns:

the String Value of that named property, if there is one - null otherwise

Throws:

RepositoryException

toString

public abstract java.lang.String toString()

Returns a string representation of the Value. Connector developers may count on this for debugging.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the Value

setFeedTimeZone

public static void setFeedTimeZone(java.lang.String id)

Sets the time zone used to format date values for the feed to the given time zone.

Parameters:

id - the time zone ID, or null or "" (empty string) to specify the default time zone

Since:

2.4.4

See Also:

TimeZone.getTimeZone(java.lang.String), TimeZone.getDefault()

calendarToFeedXml

public static java.lang.String calendarToFeedXml(java.util.Calendar calendar)

Formats a calendar object for the Feeds Protocol, using the ISO-8601 format for just the date portion. See Feeds Protocol Developer's Guide

Parameters:

calendar - a Calendar

Returns:

a String in ISO-8601 date format

calendarToRfc822

public static java.lang.String calendarToRfc822(java.util.Calendar calendar)

Formats a calendar object according to the RFC 822 specification.

Parameters:

calendar - a Calendar

Returns:

a String in RFC 822 format

calendarToIso8601

public static java.lang.String calendarToIso8601(java.util.Calendar calendar)

Formats a calendar object according to the ISO-8601 specification.

Parameters:

calendar - a Calendar

Returns:

a String in ISO-8601 format

iso8601ToCalendar

public static java.util.Calendar iso8601ToCalendar(java.lang.String dateString)
                                            throws java.text.ParseException

Parses a String in ISO-8601 format (GMT zone) and returns an equivalent java.util.Calendar object.

Parameters:

dateString - the date string to parse

Returns:

a Calendar object

Throws:

java.text.ParseException - if the the String can not be parsed