com.starteam
Class MapProperty

java.lang.Object
  com.starteam.Property
      com.starteam.VectorProperty
          com.starteam.MapProperty

All Implemented Interfaces:

java.lang.Cloneable

public class MapProperty
extends VectorProperty

A Map Property supports the assignment of a java.util.Map as a StarTeam Property value. The property value is serialized and saved to the StarTeam Server (and the underlying database) as a structured set of Key value Pairs using a simple KVP schema The Map Property supports a wide range of native and SDK value types, including String, Integer, Long, Boolean, Double, Float and java.util.Date It also supports the SDK types Date, DateTime, MD5, GUID, DotNotation, TimeSpan and Content

Nested Class Summary

static class

MapProperty.WebCacheMapProperty Base accessor for cached SDK objects encapsulating the statefulness of objects obtained from the artifact cache.

Nested classes/interfaces inherited from class com.starteam.VectorProperty

VectorProperty.WebCacheVectorProperty

Nested classes/interfaces inherited from class com.starteam.Property

Property.MetaData, Property.WebCacheProperty

Method Summary

java.lang.String	getDefaultValue() Returns the default String value for this property instance
java.lang.String	getDisplayValue(java.lang.Object value) Converts the given property value to a string suitable for display.
boolean	isQueryRelationSupported(QueryPart.Relation operator) Returns true if this property supports the specified query operator.
QueryPart	newQueryPart(QueryPart.Relation relation, java.lang.Object value) Creates a new query expression that tests this property.

Methods inherited from class com.starteam.VectorProperty

copy, getAbsoluteMaxLength, getMaxLength, getMinLength, isEqualTo, setMaxLength, setMinLength

Methods inherited from class com.starteam.Property

areValuesEqual, equals, getDebugString, getDependentProperties, getDisplayName, getDisplayNameTranslations, getGenericDefaultValue, getID, getName, getServer, getType, hashCode, isAdvanced, isCalculated, isClientCalculated, isDescriptor, isDirty, isDisabled, isEnabled, isGenericCalculated, isHeader, isItemProperty, isLegalValue, isNew, isPrimaryDescriptor, isRequired, isRestricted, isRevisionIndependent, isServerCalculated, isSortByTextValueSupported, isStored, isSysDefined, isUserCustomized, isUserDefined, isUserModifiable, isViewSpecific, resolveAllDependencies, setDescriptor, setDisplayName, setDisplayNameTranslations, setEnabled, setGenericDefaultValue, setPrimaryDescriptor, setRequired, toString, toXml, update

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getDisplayValue

public java.lang.String getDisplayValue(java.lang.Object value)

Converts the given property value to a string suitable for display.

Specified by:

getDisplayValue in class Property

Parameters:

value - A legal value for this property.

Returns:

A string representation of the value

newQueryPart

public QueryPart newQueryPart(QueryPart.Relation relation,
                              java.lang.Object value)

Creates a new query expression that tests this property.

Parameters:

relation - The query relation.

value - The value to be tested. If the query relation is Key_Contains_Value, then the value is really in 2 parts, a key to test for and a value to pair up against the key. In this case, the value MUST be specified as an Object[] of 2 parts. the first part is the Key, the second is the Value. For the other supported relations, i.e. CONTAINS, CONTAINS_KEY and CONTAINS_VALUE the value must be an object from one of the primitive value types below. String, Integer, Long, Double, DateTime

Returns:

A new query expression.

isQueryRelationSupported

public boolean isQueryRelationSupported(QueryPart.Relation operator)

Returns true if this property supports the specified query operator.

Overrides:

isQueryRelationSupported in class Property

Parameters:

operator - a query operator

Returns:

boolean true if the relation is supported

getDefaultValue

public java.lang.String getDefaultValue()

Returns the default String value for this property instance

Returns:

String