com.apelon.dts.client.attribute
Class PropertiedObject

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

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

DTSConcept, Term

public abstract class PropertiedObject
extends DTSObject

This class provides methods common to objects which have properties: DTSConcepts and Terms.

Copyright: Copyright (c) 2003

Company: Apelon, Inc.

Since:

DTS 3.0.0

Version:

DTS 3.0.0

Author:

Apelon, Inc.

Constructor Summary

	PropertiedObject()
protected	PropertiedObject(String name, int id, String code, int namespaceId) Contructs a PropertiedObject which has a name, code, ID, and namespace ID.

Method Summary

boolean	addProperty(DTSProperty prop) Adds the specified element as property for this item.
boolean	containsProperty(DTSProperty prop) Tests if this item already has the specified property.
boolean	deleteProperty(DTSProperty prop) Deletes the specified element as property for this item.
DTSProperty[]	getFetchedProperties() Gets the properties which have been retrieved for this item.
int	getNumberOfSpecifiedProperties() Get the number of properties that are available of the types specified in the ConceptAttributeSetDescriptor or TermAttributeSetDescriptor used to obtain this DTSConcept or Term, respectively.
DTSProperty[]	getProperties()
void	setProperties(DTSProperty[] props)

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertiedObject

public PropertiedObject()

PropertiedObject

protected PropertiedObject(String name,
                           int id,
                           String code,
                           int namespaceId)

Contructs a PropertiedObject which has a name, code, ID, and namespace ID.

Parameters:

name - the name of the PropertiedObject

id - the ID string of the PropertiedObject

code - the code of the PropertiedObject

namespaceId - the numerical ID of the PropertiedObject's namespace

Method Detail

addProperty

public boolean addProperty(DTSProperty prop)

Adds the specified element as property for this item.

Parameters:

prop - DTSProperty to add

Returns:

false if the item already had the property; true if the property was added

containsProperty

public boolean containsProperty(DTSProperty prop)

Tests if this item already has the specified property.

Parameters:

prop - the DTSProperty to test

Returns:

true if this item contains the property argument; otherwise false

deleteProperty

public boolean deleteProperty(DTSProperty prop)

Deletes the specified element as property for this item.

Parameters:

prop - DTSProperty to delete

Returns:

true if removed successfully; otherwise false

getFetchedProperties

public DTSProperty[] getFetchedProperties()

Gets the properties which have been retrieved for this item. If a property is qualified, it will be returned with any qualifiers that are attached.

Returns:

an array of the properties

getProperties

public DTSProperty[] getProperties()

setProperties

public void setProperties(DTSProperty[] props)

getNumberOfSpecifiedProperties

public int getNumberOfSpecifiedProperties()

Get the number of properties that are available of the types specified in the ConceptAttributeSetDescriptor or TermAttributeSetDescriptor used to obtain this DTSConcept or Term, respectively.

Returns:

number of properties of the specified types