org.sblim.slp

Class ServiceLocationAttribute

public class ServiceLocationAttribute extends Object implements Serializable

Service location attribute
Constructor Summary
ServiceLocationAttribute(String pId, Vector<Object> pValues)
Construct a service location attribute.
ServiceLocationAttribute(String pString)
Construct a service location attribute from a String.
Method Summary
static StringescapeId(String pId)
Returns an escaped version of the id parameter, suitable for inclusion in a query.
static StringescapeValue(Object pValue)
Returns a String containing the escaped value parameter as a string, suitable for inclusion in a query.
StringgetId()
Returns the attribute's name.
Vector<Object>getValues()
Returns a cloned vector of attribute values, or null if the attribute is a keyword attribute.

Constructor Detail

ServiceLocationAttribute

public ServiceLocationAttribute(String pId, Vector<Object> pValues)
Construct a service location attribute. Errors in the id or values vector result in an IllegalArgumentException.

Parameters: pId The attribute name. The String can consist of any Unicode character. pValues A Vector of one or more attribute values. Vector contents must be uniform in type and one of Integer, String, Boolean, or byte[]. If the attribute is a keyword attribute, then the parameter should be null. String values can consist of any Unicode character.

ServiceLocationAttribute

public ServiceLocationAttribute(String pString)
Construct a service location attribute from a String.

Parameters: pString The string to parse

Throws: ServiceLocationException When the string parsing failed

Method Detail

escapeId

public static String escapeId(String pId)
Returns an escaped version of the id parameter, suitable for inclusion in a query. Any reserved characters as specified in [7] are escaped using UTF-8 encoding. If any characters in the tag are illegal, throws IllegalArgumentException.

Parameters: pId The attribute id to escape. ServiceLocationException is thrown if any characters are illegal for an attribute tag.

Returns: The escaped version

escapeValue

public static String escapeValue(Object pValue)
Returns a String containing the escaped value parameter as a string, suitable for inclusion in a query. If the parameter is a string, any reserved characters as specified in [7] are escaped using UTF-8 encoding. If the parameter is a byte array, then the escaped string begins with the nonUTF-8 sequence `\ff` and the rest of the string consists of the escaped bytes, which is the encoding for opaque. If the value parameter is a Boolean or Integer, then the returned string contains the object converted into a string. If the value is any type other than String, Integer, Boolean or byte[], an IllegalArgumentException is thrown.

Parameters: pValue The attribute value to be converted into a string and escaped.

Returns: The escaped value

getId

public String getId()
Returns the attribute's name.

Returns: The name (id)

getValues

public Vector<Object> getValues()
Returns a cloned vector of attribute values, or null if the attribute is a keyword attribute. If the attribute is single-valued, then the vector contains only one object.

Returns: The value vector

Copyright © 2005, 2009 IBM Corporation. All Rights Reserved.