ro.sync.contentcompletion.xml

Class CIValue

java.lang.Object

ro.sync.contentcompletion.xml.CIValue

All Implemented Interfaces:

java.lang.Comparable<CIValue>

Direct Known Subclasses:

CILevelValue

@API(type=EXTENDABLE,
     src=PRIVATE)
public class CIValue
extends java.lang.Object
implements java.lang.Comparable<CIValue>

Interface for objects holding information about element or attribute values used in the content completion process.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	afterInsertCaretPosition The position in text where to place the caret position after insert value.
static int	TYPE_FILE_NAME Marks that the value represents a name of a file.
static int	TYPE_FOLDER Marks that the value represents a name of a folder.
static int	TYPE_PLAIN Marks that the value is a plain text value with no additional meaning.
static int	TYPE_XSLT_ATTRIBUTE Marks that the value represents a name of an attribute from the document.
static int	TYPE_XSLT_AXIS Marks that the value represents an axis in XSLT.
static int	TYPE_XSLT_ELEMENT Marks that the value represents a name of an element from the document.
static int	TYPE_XSLT_FUNCTION Marks that the value represents an XSLT function.

Constructor Summary

Constructors

Constructor and Description
CIValue(java.lang.String value) Creates a CIValue.
CIValue(java.lang.String value, boolean listValue) Creates a CIValue.
CIValue(java.lang.String value, boolean listValue, java.lang.String annotation) Creates a CIValue.
CIValue(java.lang.String value, boolean listValue, java.lang.String annotation, boolean defaultValue) Creates a CIValue.
CIValue(java.lang.String value, boolean listValue, java.lang.String annotation, java.lang.String insertString, int type) Creates a CIValue.
CIValue(java.lang.String value, boolean listValue, java.lang.String annotation, java.lang.String insertString, int type, boolean defaultValue) Creates a CIValue.
CIValue(java.lang.String value, boolean listValue, java.lang.String annotation, java.lang.String insertString, int type, boolean defaultValue, int afterInsertCaretPosition) Creates a CIValue.
CIValue(java.lang.String fullPrefix, CIValue ciValue) Create a CIValue from another one by adding a prefix to the original value.
CIValue(java.lang.String value, java.lang.String annotation) Creates a CIValue.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(CIValue other) Compares the String values.
boolean	equals(java.lang.Object obj) Test if a CIValue is equal with this one.
int	getAfterInsertCaretPosition() Get the relative position where to place the caret after the value is inserted.
java.lang.String	getAnnotation() Get the annotation associated with this value.
static CIValue[]	getCIFromIDValues(java.util.Collection<ro.sync.xml.parser.IDValue> values, boolean multipleValue) Utility method to get an array of CIValue from a list of strings.
static CIValue[]	getCIValues(java.util.Collection<java.lang.String> values) Utility method to get an array of CIValue from a list of strings.
static java.util.List<CIValue>	getCIValuesAsList(java.util.Collection<java.lang.String> values) Get a list of CIValue from a list of strings.
static java.util.List<CIValue>	getCIValuesAsList(java.util.Collection<java.lang.String> values, java.lang.String defaultValue) Get a list of CIValue from a list of strings.
java.lang.String	getInsertString() Get the insert string.
int	getType() Get the type of the value.
java.lang.String	getValue() Get the actual value as detected in the associated schema.
int	hashCode()
boolean	isDefaultValue() Get the default value flag.
boolean	isListValue() Check if the value is an entry in a list value.
void	setAfterInsertCaretPosition(int afterInsertCaretPosition) Set the relative position where to place the caret after the value is inserted.
void	setAnnotation(java.lang.String annotation) Set the annotation associated with this value.
void	setDefaultValue() Mark the value as default value.
void	setInsertString(java.lang.String insertString) Sets the insert string.
void	setListValue() Mark the value as belonging to a list value.
protected void	setValue(java.lang.String value) Sets the value.
java.lang.String	toString() Get a String representation of this CIValue.
java.lang.Object	valueOf(java.lang.String str) IMPORTANT DO NOT DELETE! This is needed by a combo box editor to see if it is the same value as the old one.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

afterInsertCaretPosition

protected int afterInsertCaretPosition

The position in text where to place the caret position after insert value. If value is -1, then the caret position is not and must be computed.

TYPE_PLAIN

public static final int TYPE_PLAIN

Marks that the value is a plain text value with no additional meaning. The value is 0

See Also:

Constant Field Values

TYPE_XSLT_AXIS

public static final int TYPE_XSLT_AXIS

Marks that the value represents an axis in XSLT. The value is 1

See Also:

Constant Field Values

TYPE_XSLT_FUNCTION

public static final int TYPE_XSLT_FUNCTION

Marks that the value represents an XSLT function. The value is 2

See Also:

Constant Field Values

TYPE_XSLT_ELEMENT

public static final int TYPE_XSLT_ELEMENT

Marks that the value represents a name of an element from the document. The value is 3

See Also:

Constant Field Values

TYPE_XSLT_ATTRIBUTE

public static final int TYPE_XSLT_ATTRIBUTE

Marks that the value represents a name of an attribute from the document. The value is 4

See Also:

Constant Field Values

TYPE_FOLDER

public static final int TYPE_FOLDER

Marks that the value represents a name of a folder. The value is 5

See Also:

Constant Field Values

TYPE_FILE_NAME

public static final int TYPE_FILE_NAME

Marks that the value represents a name of a file. The value is 6

See Also:

Constant Field Values

Constructor Detail

CIValue

public CIValue(java.lang.String value)

Creates a CIValue.

Parameters:

value - The actual value.

CIValue

public CIValue(java.lang.String value,
       boolean listValue)

Creates a CIValue.

Parameters:

value - The actual value.

listValue - Flag indicating if the value is an entry from a list value.

CIValue

public CIValue(java.lang.String value,
       java.lang.String annotation)

Creates a CIValue.

Parameters:

value - The actual value.

annotation - The annotation associated with this value.

CIValue

public CIValue(java.lang.String value,
       boolean listValue,
       java.lang.String annotation)

Creates a CIValue.

Parameters:

value - The actual value.

listValue - Flag indicating if the value is an entry from a list value.

annotation - The annotation associated with this value.

CIValue

public CIValue(java.lang.String value,
       boolean listValue,
       java.lang.String annotation,
       boolean defaultValue)

Creates a CIValue.

Parameters:

value - The actual value.

listValue - Flag indicating if the value is an entry from a list value.

annotation - The annotation associated with this value.

defaultValue - true if it is the default value.

CIValue

public CIValue(java.lang.String value,
       boolean listValue,
       java.lang.String annotation,
       java.lang.String insertString,
       int type)

Creates a CIValue.

Parameters:

value - The actual value.

listValue - Flag indicating if the value is an entry from a list value.

annotation - The annotation associated with this value.

insertString - The string to be inserted in the document when the CIValue is chosen from the content completion list of proposals. If null, the value will be used.

type - The type of the value. Use by the renderer.
Can be one of the constants: TYPE_PLAIN, TYPE_XSLT_AXIS, TYPE_XSLT_FUNCTION, TYPE_XSLT_ELEMENT, TYPE_XSLT_ATTRIBUTE

CIValue

public CIValue(java.lang.String value,
       boolean listValue,
       java.lang.String annotation,
       java.lang.String insertString,
       int type,
       boolean defaultValue)

Creates a CIValue.

Parameters:

value - The actual value.

listValue - Flag indicating if the value is an entry from a list value.

annotation - The annotation associated with this value.

insertString - The string to be inserted in the document when the CIValue is chosen from the content completion list of proposals. If null, the value will be used.

type - The type of the value. Use by the renderer.
Can be one of the constants: TYPE_PLAIN, TYPE_XSLT_AXIS, TYPE_XSLT_FUNCTION, TYPE_XSLT_ELEMENT, TYPE_XSLT_ATTRIBUTE

defaultValue - true if it is the default value.

CIValue

public CIValue(java.lang.String value,
       boolean listValue,
       java.lang.String annotation,
       java.lang.String insertString,
       int type,
       boolean defaultValue,
       int afterInsertCaretPosition)

Creates a CIValue.

Parameters:

value - The actual value.

listValue - Flag indicating if the value is an entry from a list value.

annotation - The annotation associated with this value.

insertString - The string to be inserted in the document when the CIValue is chosen from the content completion list of proposals. If null, the value will be used.

type - The type of the value. Use by the renderer.
Can be one of the constants: TYPE_PLAIN, TYPE_XSLT_AXIS, TYPE_XSLT_FUNCTION, TYPE_XSLT_ELEMENT, TYPE_XSLT_ATTRIBUTE

defaultValue - true if it is the default value.

afterInsertCaretPosition - The position in text where to place the caret position after insert value. If value is -1, then the caret position is not and must be computed.

CIValue

public CIValue(java.lang.String fullPrefix,
       CIValue ciValue)

Create a CIValue from another one by adding a prefix to the original value.

Parameters:

fullPrefix - The full prefix of the value field.

ciValue - The CIValue to use when creating a new one.

Method Detail

getValue

public java.lang.String getValue()

Get the actual value as detected in the associated schema.

Returns:

The value of the CIValue.

isListValue

public boolean isListValue()

Check if the value is an entry in a list value.

Returns:

true if the value is part of a list.

setListValue

public void setListValue()

Mark the value as belonging to a list value.

getAnnotation

public java.lang.String getAnnotation()

Get the annotation associated with this value. The annotation is an additional text description (for example documentation) of the value which is usually displayed when the user browses possible values.

Returns:

The value annotation.

setAnnotation

public void setAnnotation(java.lang.String annotation)

Set the annotation associated with this value. The annotation is an additional text description (for example documentation) of the value which is usually displayed when the user browses possible values.

Parameters:

annotation - The value annotation.

getCIValues

public static CIValue[] getCIValues(java.util.Collection<java.lang.String> values)

Utility method to get an array of CIValue from a list of strings. Assumes no annotations and no list types are present.

Parameters:

values - A collection of String values.

Returns:

An array of CIValues.

getCIFromIDValues

public static CIValue[] getCIFromIDValues(java.util.Collection<ro.sync.xml.parser.IDValue> values,
                          boolean multipleValue)

Utility method to get an array of CIValue from a list of strings. Assumes no annotations and no list types are present.

Parameters:

values - A collection of String values.

multipleValue - true if the value allows multiple values.

Returns:

An array of CIValues.

getCIValuesAsList

public static java.util.List<CIValue> getCIValuesAsList(java.util.Collection<java.lang.String> values)

Get a list of CIValue from a list of strings. Assumes no annotation and no list types are present.

Parameters:

values - A collection of String values.

Returns:

An new list of CIValues.

getCIValuesAsList

public static java.util.List<CIValue> getCIValuesAsList(java.util.Collection<java.lang.String> values,
                                        java.lang.String defaultValue)

Get a list of CIValue from a list of strings. Assumes no annotation and no list types are present.

Parameters:

values - A collection of String values.

defaultValue - The default value

Returns:

An new list of CIValues.

equals

public boolean equals(java.lang.Object obj)

Test if a CIValue is equal with this one.

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

isDefaultValue

public boolean isDefaultValue()

Get the default value flag.

Returns:

True if the value is marked as default.

setDefaultValue

public void setDefaultValue()

Mark the value as default value.

toString

public java.lang.String toString()

Get a String representation of this CIValue.

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

compareTo

public int compareTo(CIValue other)

Compares the String values.

Specified by:

compareTo in interface java.lang.Comparable<CIValue>

See Also:

Comparable.compareTo(java.lang.Object)

getInsertString

public java.lang.String getInsertString()

Get the insert string. It represents an escaped version of the value and can be inserted directly in the document.

Returns:

The escaped value to be inserted in the document.

setInsertString

public void setInsertString(java.lang.String insertString)

Sets the insert string. It is taken into consideration only in the Text page.

Parameters:

insertString - The value to be inserted in the document.

getType

public int getType()

Get the type of the value. It may be plain text value, an axe or a function in xslt or an element from the input document involved in an transformation scenario.

Returns:

The value type. Can be one of: TYPE_PLAIN, TYPE_XSLT_AXIS, TYPE_XSLT_FUNCTION, TYPE_XSLT_ELEMENT or TYPE_XSLT_ATTRIBUTE.

valueOf

public java.lang.Object valueOf(java.lang.String str)

IMPORTANT DO NOT DELETE! This is needed by a combo box editor to see if it is the same value as the old one.

Parameters:

str - The str.

Returns:

The same object.

getAfterInsertCaretPosition

public int getAfterInsertCaretPosition()

Get the relative position where to place the caret after the value is inserted.

Returns:

The position to place the caret after inserting the string. If -1 the caret position was not computed.

setAfterInsertCaretPosition

public void setAfterInsertCaretPosition(int afterInsertCaretPosition)

Set the relative position where to place the caret after the value is inserted.

Parameters:

afterInsertCaretPosition - The afterInsertCaretPosition to set.

setValue

protected void setValue(java.lang.String value)

Sets the value.

Parameters:

value - The new value.