com.apelon.dts.client.attribute
Class DTSPropertyType

java.lang.Object
  com.apelon.dts.client.common.DTSObject
      com.apelon.dts.client.attribute.DTSPropertyType

All Implemented Interfaces:

Cloneable

public class DTSPropertyType
extends DTSObject
implements Cloneable

A property can reference user-defined information. Each property is defined by a name (definition) called the property type. When a property (type) is assigned to a concept, a value can be linked to the property that is specific to its association with the individual concept.

Copyright: Copyright (c) 2003

Company: Apelon, Inc.

Since:

DTS 3.0.0

Version:

DTS 3.0.0

Author:

Apelon, Inc.

See Also:

DTSProperty

Constructor Summary

DTSPropertyType()

DTSPropertyType(String name, int namespaceId, PropertyValueSize valueSize, ModifiesItemType attachesTo, boolean isWordSearchable)
Constructs a new PropertyType for concepts or terms: the id and code for this type are generated when it is added to the server.

DTSPropertyType(String name, int id, String code, int namespaceId, PropertyValueSize valueSize, ModifiesItemType attachesTo, boolean isWordSearchable)
Constructs a new PropertyType for concepts or terms.

Method Summary

Object	clone() Clone this DTSPropertyType object.
boolean	equals(Object obj) Compares this property type to the specified object.
ModifiesItemType	getAttachesTo() Retrieves type of item the property attaches to.
PropertyValueSize	getValueSize() Gets the size category of the property value: indexable property, searchable property, or big property
boolean	isWordSearchable() Indicates whether an index has been created that allows the property values to be searched for words no matter in what order or where the words are found.
void	setAttachesTo(ModifiesItemType newAttachesTo) Sets type of item the property attaches to.
void	setValueSize(PropertyValueSize newValueSize) Sets size category of the property value: indexable property, searchable property, or big property.

Methods inherited from class com.apelon.dts.client.common.DTSObject

getCode, getId, getName, getNamespaceId, hashCode, setCode, setId, setName, setNamespaceId, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DTSPropertyType

public DTSPropertyType()

DTSPropertyType

public DTSPropertyType(String name,
                       int id,
                       String code,
                       int namespaceId,
                       PropertyValueSize valueSize,
                       ModifiesItemType attachesTo,
                       boolean isWordSearchable)

Constructs a new PropertyType for concepts or terms.

Parameters:

name - the property's name

id - the property's ID

code - the property's code

namespaceId - the ID of the property type's namespace

valueSize - the property value's size category: indexable, searchable, big

attachesTo - type of item which the property modifies: concept or term

isWordSearchable - indicates if the property has an index that enables word searching (independent of word order)

DTSPropertyType

public DTSPropertyType(String name,
                       int namespaceId,
                       PropertyValueSize valueSize,
                       ModifiesItemType attachesTo,
                       boolean isWordSearchable)

Constructs a new PropertyType for concepts or terms: the id and code for this type are generated when it is added to the server.

Parameters:

name - the property's name

namespaceId - the ID of the property type's namespace

valueSize - the property value's size category: indexable, searchable, big

attachesTo - type of item which the property modifies: concept or term

isWordSearchable - indicates if the property has an index that enables word searching (independent of word order)

Method Detail

clone

public Object clone()
             throws CloneNotSupportedException

Clone this DTSPropertyType object.

Overrides:

clone in class Object

Returns:

a clone of this DTSPropertyType.

Throws:

CloneNotSupportedException - if unable to create a clone

setAttachesTo

public void setAttachesTo(ModifiesItemType newAttachesTo)

Sets type of item the property attaches to.

Parameters:

newAttachesTo - ModifiesItemType indicating item modified: concept or term

getAttachesTo

public ModifiesItemType getAttachesTo()

Retrieves type of item the property attaches to.

Returns:

ModifiesItemType indicating item modified: concept or term

setValueSize

public void setValueSize(PropertyValueSize newValueSize)

Sets size category of the property value: indexable property, searchable property, or big property.

Parameters:

newValueSize - PropertyValueSize indicating size category

getValueSize

public PropertyValueSize getValueSize()

Gets the size category of the property value: indexable property, searchable property, or big property

Returns:

PropertyValueSize for property value size category

isWordSearchable

public boolean isWordSearchable()

Indicates whether an index has been created that allows the property values to be searched for words no matter in what order or where the words are found. For example, a search for the words "diluted strength" will match property values of "diluted stength solution", "solution, diluted strength", or "stength diluted solution".

Returns:

true if a property word search can be done; otherwise false

equals

public boolean equals(Object obj)

Compares this property type to the specified object.

Overrides:

equals in class DTSObject

Parameters:

obj - object to compare with

Returns:

true if the object is equal to this DTSPropertyType; false otherwise.