com.apelon.dts.client.concept
Class ConceptAttributeSetDescriptor

java.lang.Object
  com.apelon.dts.client.concept.ConceptAttributeSetDescriptor

All Implemented Interfaces:

Cloneable

public class ConceptAttributeSetDescriptor
extends Object
implements Cloneable

ConceptAttributeSetDescriptor is a description of the set of concept attributes that should be retrieved by a given operation. A concept attribute is either a DTSProperty, a DTSRole, a ConceptAssociation or Synonym. Attributes are chosen by their particular type: DTSPropertyType, DTSRoleType, or AssociationType (for concept associations and synonyms).

A typical use of a ConceptAttributeSetDescriptor by an application program would be to specify the set of concept attributes to be retrieved for the application under various circumstances. One example would be to define a ConceptAttributeSetDescriptor instance PHARMACY_ORDER_ATTRIBUTES that specifies the set of attributes needed to populate the application's Pharmacy order page. Then PHARMACY_ORDER_ATTRIBUTES would be passed to any operation performed in support of the Pharmacy order page to ensure that the right set of attributes (e.g. the NDC_Number property, the DoseForm role, etc.) was retrieved.

Copyright: Copyright (c) 2007

Company: Apelon, Inc.

Since:

DTS 3.0.0

Version:

DTS 3.4.1

Author:

Apelon, Inc.

Field Summary

static ConceptAttributeSetDescriptor	ALL_ATTRIBUTES ALL_ATTRIBUTES is a special ConceptAttributeSetDescriptor that will cause all attributes of a concept to be fetched (except Ontylog defined view attributes).
static int	DEFAULT_LIMIT Default limit on number of attributes returned of each type.
static ConceptAttributeSetDescriptor	NO_ATTRIBUTES NO_ATTRIBUTES is a special ConceptAttributeSetDescriptor that will cause no attributes of a concept to be fetched.

Constructor Summary

ConceptAttributeSetDescriptor(String name)
Constructs a ConceptAttributeSetDescriptor with the given name and no attributes.

ConceptAttributeSetDescriptor(String name, int attributesLimit)
Constructs a ConceptAttributeSetDescriptor with the given name and attribute results limit, but no attributes.

Method Summary

boolean	addConceptAssociationType(AssociationType conceptAssocType) Adds a concept association type to the set of association types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.
boolean	addInverseConceptAssociationType(AssociationType invConceptAssocType) Adds a concept association type to the set of association types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.
boolean	addInverseRoleType(DTSRoleType invRoleType) Adds a role type to the set of inverse role types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.
boolean	addPropertyType(DTSPropertyType propType) Adds a property type to the set of property types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.
boolean	addRoleType(DTSRoleType roleType) Adds a role type to the set of role types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.
boolean	addSynonymType(AssociationType synonymType) Adds a synonym type to the set of synonym types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.
static String	asXML(ConceptAttributeSetDescriptor dtsAsd) Gets an XML string to set attributes according to the argument ConceptAttributeSetDescriptor.
Object	clone() Creates and returns a copy of this object.
boolean	containsConceptAssociationType(AssociationType conceptAssocType) Tests if this ConceptAttributeSetDescriptor contains the concept AssociationType argument.
boolean	containsInverseConceptAssociationType(AssociationType invConceptAssocType) Tests if this ConceptAttributeSetDescriptor contains the concept AssociationType argument.
boolean	containsInverseRoleType(DTSRoleType invRoleType) Tests if this ConceptAttributeSetDescriptor contains the DTSRoleType argument.
boolean	containsPropertyType(DTSPropertyType propType) Tests if this ConceptAttributeSetDescriptor contains the DTSPropertyType argument.
boolean	containsRoleType(DTSRoleType roleType) Tests if this ConceptAttributeSetDescriptor contains the DTSRoleType argument.
boolean	containsSynonymType(AssociationType synonymType) Tests if this ConceptAttributeSetDescriptor contains the synonym AssociationType argument.
boolean	getAllConceptAssociationTypes() Retrieve whether all concept association types are included in this ConceptAttributeSetDescriptor.
boolean	getAllInverseConceptAssociationTypes() Retrieve whether all inverse concept association types are included in this ConceptAttributeSetDescriptor.
boolean	getAllInverseRoleTypes() Retrieve whether all inverse role types are included in this ConceptAttributeSetDescriptor.
boolean	getAllPropertyTypes() Retrieve whether all property types are included in this ConceptAttributeSetDescriptor.
boolean	getAllRoleTypes() Retrieve whether all role types are included in this ConceptAttributeSetDescriptor.
boolean	getAllSynonymTypes() Retrieve whether all synonym types are included in this ConceptAttributeSetDescriptor.
int	getAttributesLimit() Gets the limit on the number of attributes returned of each type.
AssociationType[]	getConceptAssociationTypes() Gets the set of concept association types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.
AssociationType[]	getInverseConceptAssociationTypes() Gets the set of inverse concept association types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.
DTSRoleType[]	getInverseRoleTypes() Gets the set of inverse role types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.
String	getName() Gets the name of the ConceptAttributeSetDescriptor.
DTSPropertyType[]	getPropertyTypes() Gets the set of property types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.
boolean	getQueryHasSubs() Tests whether or not to find out if the concept has subconcept(s).
boolean	getQueryHasSups() Tests whether or not to find out if the concept has superconcept(s).
DTSRoleType[]	getRoleTypes() Gets the set of role types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.
AssociationType[]	getSynonymTypes() Gets the set of synonym types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.
boolean	isDefinedViewAttributes() Tests whether defined view attributes of an Ontylog concept are to be retrieved.
boolean	isSubconcepts() Tests whether subconcepts of an Ontylog concept are to be retrieved.
boolean	isSuperconcepts() Tests whether superconcepts of an Ontylog concept are to be retrieved.
boolean	removeConceptAssociationType(AssociationType conceptAssocType) Removes the association type from the ConceptAttributeSetDescriptor.
boolean	removeInverseConceptAssociationType(AssociationType invConceptAssocType) Removes the inverse concept association type from the ConceptAttributeSetDescriptor.
boolean	removeInverseRoleType(DTSRoleType invRoleType) Removes the role type from the set of inverse role types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.
boolean	removePropertyType(DTSPropertyType propType) Removes the property type from the ConceptAttributeSetDescriptor.
boolean	removeRoleType(DTSRoleType role) Removes the role type from the ConceptAttributeSetDescriptor.
boolean	removeSynonymType(AssociationType synonymType) Removes the synonym type from the ConceptAttributeSetDescriptor.
void	setAllConceptAssociationTypes(boolean allConceptAssociationTypes) Set whether all concept association types are included in this ConceptAttributeSetDescriptor.
void	setAllInverseConceptAssociationTypes(boolean allInverseConceptAssociationTypes) Set whether all inverse concept association types are included in this ConceptAttributeSetDescriptor.
void	setAllInverseRoleTypes(boolean allInverseRoleTypes) Set whether all inverse role types are included in this ConceptAttributeSetDescriptor.
void	setAllPropertyTypes(boolean allPropertyTypes) Set whether all property types are included in this ConceptAttributeSetDescriptor.
void	setAllRoleTypes(boolean allRoleTypes) Set whether all role types are included in this ConceptAttributeSetDescriptor.
void	setAllSynonymTypes(boolean allSynonymTypes) Set whether all synonym types are included in this ConceptAttributeSetDescriptor.
void	setAttributesLimit(int newAttributesLimit) Sets the limit on the number of attributes returned of each type.
void	setConceptAssociationTypes(AssociationType[] conceptAssocTypes) Sets the concept association types to be retrieved by any operation that uses this ConceptAttributeSetDescriptor.
void	setDefinedViewAttributes(boolean definedViewAttributes) Specifies whether to retrieve defined view attributes of an Ontylog concept.
void	setInverseConceptAssociationTypes(AssociationType[] invConceptAssocTypes) Sets the inverse concept association types to be retrieved by any operation that uses this ConceptAttributeSetDescriptor.
void	setInverseRoleTypes(DTSRoleType[] invRoleTypes) Sets the set of inverse role types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.
void	setName(String newName) Sets the name of the ConceptAttributeSetDescriptor.
void	setPropertyTypes(DTSPropertyType[] propTypes) Sets the set of property types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.
void	setQueryHasSubs(boolean subs) Sets whether or not to find out if the concept has subconcept(s).
void	setQueryHasSups(boolean sups) Sets whether or not to find out if the concept has superconcept(s).
void	setRoleTypes(DTSRoleType[] roleTypes) Sets the set of role types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.
void	setSubconcepts(boolean subconcepts) Specifies whether to retrieve subconcepts of an Ontylog concept.
void	setSuperconcepts(boolean superconcepts) Specifies whether to retrieve superconcepts of an Ontylog concept.
void	setSynonymTypes(AssociationType[] synonymTypes) Sets the synonym types to be retrieved by any operation that uses this ConceptAttributeSetDescriptor.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALL_ATTRIBUTES

public static final ConceptAttributeSetDescriptor ALL_ATTRIBUTES

ALL_ATTRIBUTES is a special ConceptAttributeSetDescriptor that will cause all attributes of a concept to be fetched (except Ontylog defined view attributes). Do not attempt to modify this static object.

NO_ATTRIBUTES

public static final ConceptAttributeSetDescriptor NO_ATTRIBUTES

NO_ATTRIBUTES is a special ConceptAttributeSetDescriptor that will cause no attributes of a concept to be fetched. Do not attempt to modify this static object.

DEFAULT_LIMIT

public static final int DEFAULT_LIMIT

Default limit on number of attributes returned of each type.

See Also:

Constant Field Values

Constructor Detail

ConceptAttributeSetDescriptor

public ConceptAttributeSetDescriptor(String name)

Constructs a ConceptAttributeSetDescriptor with the given name and no attributes.

Sets the attribute limit to DEFAULT_LIMIT.

Parameters:

name - the name of the ConceptAttributeSetDescriptor

ConceptAttributeSetDescriptor

public ConceptAttributeSetDescriptor(String name,
                                     int attributesLimit)

Constructs a ConceptAttributeSetDescriptor with the given name and attribute results limit, but no attributes.

Parameters:

name - the name of the ConceptAttributeSetDescriptor

attributesLimit - limit on the number of attributes returned of each type

Method Detail

setName

public void setName(String newName)

Sets the name of the ConceptAttributeSetDescriptor.

Parameters:

newName - new name of the ConceptAttributeSetDescriptor

getName

public String getName()

Gets the name of the ConceptAttributeSetDescriptor. For example: Pharmacy_Order_Attributes.

Returns:

the name of the ConceptAttributeSetDescriptor instance

setAttributesLimit

public void setAttributesLimit(int newAttributesLimit)

Sets the limit on the number of attributes returned of each type.

Parameters:

newAttributesLimit - new attributes limit of the ConceptAttributeSetDescriptor

getAttributesLimit

public int getAttributesLimit()

Gets the limit on the number of attributes returned of each type.

Returns:

the attributes limit of this ConceptAttributeSetDescriptor

setPropertyTypes

public void setPropertyTypes(DTSPropertyType[] propTypes)

Sets the set of property types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor. Any existing property types in the ConceptAttributeSetDescriptor are removed.

Parameters:

propTypes - the property types of the ConceptAttributeSetDescriptor

Throws:

IllegalArgumentException - if the specified array is null.

containsPropertyType

public boolean containsPropertyType(DTSPropertyType propType)

Tests if this ConceptAttributeSetDescriptor contains the DTSPropertyType argument.

Parameters:

propType - the property type used to test if it is contained in the ConceptAttributeSetDescriptor

Returns:

true if this ConceptAttributeSetDescriptor contains the DTSPropertyType argument, or else false

addPropertyType

public boolean addPropertyType(DTSPropertyType propType)

Adds a property type to the set of property types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.

Parameters:

propType - the property type which is added

Returns:

false if the property type was already in the ConceptAttributeSetDescriptor, true if the property type was added

removePropertyType

public boolean removePropertyType(DTSPropertyType propType)

Removes the property type from the ConceptAttributeSetDescriptor.

Parameters:

propType - the property type which is removed

Returns:

true if removed successfully, false otherwise

getPropertyTypes

public DTSPropertyType[] getPropertyTypes()

Gets the set of property types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.

Returns:

an array of property types

setAllPropertyTypes

public void setAllPropertyTypes(boolean allPropertyTypes)

Set whether all property types are included in this ConceptAttributeSetDescriptor.

Parameters:

allPropertyTypes - true if all property types are included; false otherwise.

getAllPropertyTypes

public boolean getAllPropertyTypes()

Retrieve whether all property types are included in this ConceptAttributeSetDescriptor.

Returns:

boolean indicating whether all property types are included.

setConceptAssociationTypes

public void setConceptAssociationTypes(AssociationType[] conceptAssocTypes)

Sets the concept association types to be retrieved by any operation that uses this ConceptAttributeSetDescriptor. Any existing concept association types in the ConceptAttributeSetDescriptor are removed.

Parameters:

conceptAssocTypes - concept association types to be retrieved

containsConceptAssociationType

public boolean containsConceptAssociationType(AssociationType conceptAssocType)

Tests if this ConceptAttributeSetDescriptor contains the concept AssociationType argument.

Parameters:

conceptAssocType - the concept association type used to test if it is contained in the ConceptAttributeSetDescriptor

Returns:

true if this ConceptAttributeSetDescriptor contains the concept AssociationType argument; otherwise false

addConceptAssociationType

public boolean addConceptAssociationType(AssociationType conceptAssocType)

Adds a concept association type to the set of association types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.

Parameters:

conceptAssocType - the concept association type which is added

Returns:

false if the association type was already in the ConceptAttributeSetDescriptor; true if the association type was added

removeConceptAssociationType

public boolean removeConceptAssociationType(AssociationType conceptAssocType)

Removes the association type from the ConceptAttributeSetDescriptor.

Parameters:

conceptAssocType - the concept association type to be removed

Returns:

true if removed successfully; otherwise false

getConceptAssociationTypes

public AssociationType[] getConceptAssociationTypes()

Gets the set of concept association types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.

Returns:

an array of concept association types

setAllConceptAssociationTypes

public void setAllConceptAssociationTypes(boolean allConceptAssociationTypes)

Set whether all concept association types are included in this ConceptAttributeSetDescriptor.

Parameters:

allConceptAssociationTypes - true if all concept association types are included; false otherwise.

getAllConceptAssociationTypes

public boolean getAllConceptAssociationTypes()

Retrieve whether all concept association types are included in this ConceptAttributeSetDescriptor.

Returns:

boolean indicating whether all concept association types are included.

setInverseConceptAssociationTypes

public void setInverseConceptAssociationTypes(AssociationType[] invConceptAssocTypes)

Sets the inverse concept association types to be retrieved by any operation that uses this ConceptAttributeSetDescriptor. Any existing inverse concept association types in the ConceptAttributeSetDescriptor are removed.

Parameters:

invConceptAssocTypes - inverse concept association types to be retrieved

Throws:

IllegalArgumentException - if the specified array is null.

containsInverseConceptAssociationType

public boolean containsInverseConceptAssociationType(AssociationType invConceptAssocType)

Tests if this ConceptAttributeSetDescriptor contains the concept AssociationType argument.

Parameters:

invConceptAssocType - the concept association type used to test if it is contained in the ConceptAttributeSetDescriptor

Returns:

true if this ConceptAttributeSetDescriptor contains the concept AssociationType argument; otherwise false

addInverseConceptAssociationType

public boolean addInverseConceptAssociationType(AssociationType invConceptAssocType)

Adds a concept association type to the set of association types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.

Parameters:

invConceptAssocType - the concept association type which is added

Returns:

false if the association type was already in the ConceptAttributeSetDescriptor; true if the association type was added

removeInverseConceptAssociationType

public boolean removeInverseConceptAssociationType(AssociationType invConceptAssocType)

Removes the inverse concept association type from the ConceptAttributeSetDescriptor.

Parameters:

invConceptAssocType - the inverse concept association type to be removed

Returns:

true if removed successfully; otherwise false

getInverseConceptAssociationTypes

public AssociationType[] getInverseConceptAssociationTypes()

Gets the set of inverse concept association types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.

Returns:

an array of inverse concept association types

setAllInverseConceptAssociationTypes

public void setAllInverseConceptAssociationTypes(boolean allInverseConceptAssociationTypes)

Set whether all inverse concept association types are included in this ConceptAttributeSetDescriptor.

Parameters:

allInverseConceptAssociationTypes - true if all inverse concept association types are included; false otherwise.

getAllInverseConceptAssociationTypes

public boolean getAllInverseConceptAssociationTypes()

Retrieve whether all inverse concept association types are included in this ConceptAttributeSetDescriptor.

Returns:

boolean indicating whether all inverse concept association types are included.

setSynonymTypes

public void setSynonymTypes(AssociationType[] synonymTypes)

Sets the synonym types to be retrieved by any operation that uses this ConceptAttributeSetDescriptor. Any existing synonym types in the ConceptAttributeSetDescriptor are removed.

Parameters:

synonymTypes - synonym types to be retrieved

Throws:

IllegalArgumentException - if the specified array is null.

containsSynonymType

public boolean containsSynonymType(AssociationType synonymType)

Tests if this ConceptAttributeSetDescriptor contains the synonym AssociationType argument.

Parameters:

synonymType - the synonym type used to test if it is contained in the ConceptAttributeSetDescriptor

Returns:

true if this ConceptAttributeSetDescriptor contains the AssociationType argument; otherwise false

addSynonymType

public boolean addSynonymType(AssociationType synonymType)

Adds a synonym type to the set of synonym types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.

Parameters:

synonymType - the synonym type which is added

Returns:

false if the synonym type was already in the ConceptAttributeSetDescriptor; true if the synonym type was added

removeSynonymType

public boolean removeSynonymType(AssociationType synonymType)

Removes the synonym type from the ConceptAttributeSetDescriptor.

Parameters:

synonymType - the synonym type which is removed

Returns:

true if removed successfully; otherwise false

getSynonymTypes

public AssociationType[] getSynonymTypes()

Gets the set of synonym types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.

Returns:

an array of synonym association types

setAllSynonymTypes

public void setAllSynonymTypes(boolean allSynonymTypes)

Set whether all synonym types are included in this ConceptAttributeSetDescriptor.

Parameters:

allSynonymTypes - true if all synonym types are included; false otherwise.

getAllSynonymTypes

public boolean getAllSynonymTypes()

Retrieve whether all synonym types are included in this ConceptAttributeSetDescriptor.

Returns:

boolean indicating whether all synonym types are included.

setRoleTypes

public void setRoleTypes(DTSRoleType[] roleTypes)

Sets the set of role types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.

Parameters:

roleTypes - an array of role types

Throws:

IllegalArgumentException - if the specified array is null.

containsRoleType

public boolean containsRoleType(DTSRoleType roleType)

Tests if this ConceptAttributeSetDescriptor contains the DTSRoleType argument.

Parameters:

roleType - the role type which is tested

Returns:

true if this ConceptAttributeSetDescriptor contains the DTSRoleType argument, or else false

addRoleType

public boolean addRoleType(DTSRoleType roleType)

Adds a role type to the set of role types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.

Parameters:

roleType - the role type which is added

Returns:

false if the role type was already in the ConceptAttributeSetDescriptor, true if the role type was added

removeRoleType

public boolean removeRoleType(DTSRoleType role)

Removes the role type from the ConceptAttributeSetDescriptor.

Parameters:

role - the role type which is removed

Returns:

true if removed successfully, false if removed unsuccessfully

getRoleTypes

public DTSRoleType[] getRoleTypes()

Gets the set of role types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.

Returns:

an array of the set of role types

setAllRoleTypes

public void setAllRoleTypes(boolean allRoleTypes)

Set whether all role types are included in this ConceptAttributeSetDescriptor.

Parameters:

allRoleTypes - true if all role types are included; false otherwise.

getAllRoleTypes

public boolean getAllRoleTypes()

Retrieve whether all role types are included in this ConceptAttributeSetDescriptor.

Returns:

boolean indicating whether all role types are included.

setInverseRoleTypes

public void setInverseRoleTypes(DTSRoleType[] invRoleTypes)

Sets the set of inverse role types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.

Parameters:

invRoleTypes - an array of role types

Throws:

IllegalArgumentException - if the specified array is null.

containsInverseRoleType

public boolean containsInverseRoleType(DTSRoleType invRoleType)

Tests if this ConceptAttributeSetDescriptor contains the DTSRoleType argument.

Parameters:

invRoleType - the role type which is tested

Returns:

true if this ConceptAttributeSetDescriptor contains the DTSRoleType argument, or else false

addInverseRoleType

public boolean addInverseRoleType(DTSRoleType invRoleType)

Adds a role type to the set of inverse role types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.

Parameters:

invRoleType - the role type which is added

Returns:

false if the role type was already in the ConceptAttributeSetDescriptor, true if the role type was added

removeInverseRoleType

public boolean removeInverseRoleType(DTSRoleType invRoleType)

Removes the role type from the set of inverse role types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.

Parameters:

invRoleType - the role type which is removed

Returns:

true if removed successfully, false if removed unsuccessfully

getInverseRoleTypes

public DTSRoleType[] getInverseRoleTypes()

Gets the set of inverse role types that will be retrieved by any operation that uses this ConceptAttributeSetDescriptor.

Returns:

an array of the set of role types

setAllInverseRoleTypes

public void setAllInverseRoleTypes(boolean allInverseRoleTypes)

Set whether all inverse role types are included in this ConceptAttributeSetDescriptor.

Parameters:

allInverseRoleTypes - true if all inverse role types are included; false otherwise.

getAllInverseRoleTypes

public boolean getAllInverseRoleTypes()

Retrieve whether all inverse role types are included in this ConceptAttributeSetDescriptor.

Returns:

boolean indicating whether all inverse role types are included.

isSuperconcepts

public boolean isSuperconcepts()

Tests whether superconcepts of an Ontylog concept are to be retrieved.

Returns:

true if superconcepts are to be retrieved; false otherwise.

Since:

DTS 3.3.0

setSuperconcepts

public void setSuperconcepts(boolean superconcepts)

Specifies whether to retrieve superconcepts of an Ontylog concept.

Parameters:

superconcepts - true if superconcepts are to be retrieved; false otherwise.

Since:

DTS 3.3.0

isSubconcepts

public boolean isSubconcepts()

Tests whether subconcepts of an Ontylog concept are to be retrieved.

Returns:

true if subconcepts are to be retrieved; false otherwise.

Since:

DTS 3.3.0

setSubconcepts

public void setSubconcepts(boolean subconcepts)

Specifies whether to retrieve subconcepts of an Ontylog concept.

Parameters:

subconcepts - true if subconcepts are to be retrieved; false otherwise.

Since:

DTS 3.3.0

isDefinedViewAttributes

public boolean isDefinedViewAttributes()

Tests whether defined view attributes of an Ontylog concept are to be retrieved. These include the primitive/defined attribute, kind, defining concepts and defining roles.

Returns:

true if defined view attributes are to be retrieved; false otherwise.

Since:

DTS 3.3.0

setDefinedViewAttributes

public void setDefinedViewAttributes(boolean definedViewAttributes)

Specifies whether to retrieve defined view attributes of an Ontylog concept. These include the primitive/defined attribute, kind, defining superconcepts, and defining roles.

Parameters:

definedViewAttributes - true if defined view attributes are to be retrieved; false otherwise.

Since:

DTS 3.3.0

setQueryHasSups

public void setQueryHasSups(boolean sups)

Sets whether or not to find out if the concept has superconcept(s).

Parameters:

sups - true if the query is to find out if the concept has superconcepts; false if not.

getQueryHasSups

public boolean getQueryHasSups()

Tests whether or not to find out if the concept has superconcept(s).

Returns:

true if the query is to find out if the concept has subconcepts; false if not.

setQueryHasSubs

public void setQueryHasSubs(boolean subs)

Sets whether or not to find out if the concept has subconcept(s).

Parameters:

subs - true if the query is to find out if the concept has subconcepts; false if not.

getQueryHasSubs

public boolean getQueryHasSubs()

Tests whether or not to find out if the concept has subconcept(s).

Returns:

true if the query is to find out if the concept has subconcepts; false if not.

clone

public Object clone()
             throws CloneNotSupportedException

Creates and returns a copy of this object.

Overrides:

clone in class Object

Returns:

a copy of this object.

Throws:

CloneNotSupportedException - if the instance cannot be cloned

asXML

public static String asXML(ConceptAttributeSetDescriptor dtsAsd)

Gets an XML string to set attributes according to the argument ConceptAttributeSetDescriptor.

Parameters:

dtsAsd - the ConceptAttributeSetDescriptor that specifies which attributes are to be set

Returns:

an XML string that specifies how attributes are to be set