com.apelon.dts.client.attribute
Class QualifierTypeQuery

java.lang.Object
  com.apelon.apelonserver.client.BasicQuery
      com.apelon.dts.client.attribute.QualifierTypeQuery

Direct Known Subclasses:

AssociationQuery, PropertyTypeQuery

public abstract class QualifierTypeQuery
extends BasicQuery

QualifierTypeServer is a base query server class that allows the creation, modification, and deletion of qualfier types.

The following events are fired in this class:

• KBTypeEvent is fired for adding/modifying/deleting QualifierType

Copyright: Copyright (c) 2002

Company: Apelon, Inc.

Since:

DTS 3.0.0

Version:

DTS 3.0.0

Author:

Apelon, Inc.

Field Summary

protected KBTypeListener

kbtypeListener

Fields inherited from class com.apelon.apelonserver.client.BasicQuery

ADMIN, queryHeader

Constructor Summary

protected	QualifierTypeQuery()
protected	QualifierTypeQuery(boolean isValidating)

Method Summary

void	addKBTypeListener(KBTypeListener listener)
QualifierType	addQualifierType(QualifierType newQualifierType) Adds a new QualifierType to the knowledgebase.
boolean	deleteQualifierType(QualifierType qualifierType) Deletes a QualifierType from the knowledgebase.
QualifierType	findQualifierTypeByCode(String termCode, int namespaceId) Gets the QualifierType object with the specified code and namespace ID.
QualifierType	findQualifierTypeById(int termId, int namespaceId) Gets the QualifierType object with the specified ID and namespace ID.
QualifierType	findQualifierTypeByName(String termName, int namespaceId) Gets the QualifierType object with the specified name and namespace ID.
protected void	fireKBTypeAction(KBTypeEvent event)
QualifierType[]	getAllConceptAssociationQualifierTypes() Retrieves all concept association qualifier types.
QualifierType[]	getAllConceptPropertyQualifierTypes() Retrieves all concept property qualifier types.
QualifierType[]	getAllQualifierTypes() Retrieves all qualifier types.
QualifierType[]	getAllTermAssociationQualifierTypes() Retrieves all term association qualifier types.
QualifierType[]	getAllTermPropertyQualifierTypes() Retrieves all term property qualifier types.
QualifierType[]	getConceptAssociationQualifierTypes(int namespaceId) Retrieves all concept association qualifier types within a given namespace.
QualifierType[]	getConceptPropertyQualifierTypes(int namespaceId) Retrieves all concept property qualifier types within a given namespace.
KBTypeListener	getKBTypeListener() Get the KBTypeListener.
QualifierType[]	getTermAssociationQualifierTypes(int namespaceId) Retrieves all term association qualifier types within a given namespace.
QualifierType[]	getTermPropertyQualifierTypes(int namespaceId) Retrieves all term property qualifier types within a given namespace.
void	removeKBTypeListener(KBTypeListener listener)
QualifierType	updateQualifierType(QualifierType oldQualifierType, QualifierType newQualifierType) Updates a qualifier type in the knowledgebase corresponding to the passed old QualifierType, using the values from the new QualifierType.

Methods inherited from class com.apelon.apelonserver.client.BasicQuery

executeQuery, executeQueryNoParse, getServerConnection, initializeDtds, initializeDtds, ping, setVersion

Methods inherited from class java.lang.Object

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

Field Detail

kbtypeListener

protected transient KBTypeListener kbtypeListener

Constructor Detail

QualifierTypeQuery

protected QualifierTypeQuery()

QualifierTypeQuery

protected QualifierTypeQuery(boolean isValidating)

Method Detail

addQualifierType

public QualifierType addQualifierType(QualifierType newQualifierType)
                               throws DTSException

Adds a new QualifierType to the knowledgebase.

Parameters:

newQualifierType - QualifierType to add

Returns:

the updated QualifierType

Throws:

DTSException - if any error occurs in the method

deleteQualifierType

public boolean deleteQualifierType(QualifierType qualifierType)
                            throws DTSException

Deletes a QualifierType from the knowledgebase.

Parameters:

qualifierType - QualifierType to delete

Returns:

true if the QualifierType is successfully deleted; false if not

Throws:

DTSException - if any error occurs in the method

updateQualifierType

public QualifierType updateQualifierType(QualifierType oldQualifierType,
                                         QualifierType newQualifierType)
                                  throws DTSException

Updates a qualifier type in the knowledgebase corresponding to the passed old QualifierType, using the values from the new QualifierType.

Parameters:

oldQualifierType - the qualifier type to be updated

newQualifierType - the qualifier type as it should look when updated

Returns:

an instance of the updated qualifier type

Throws:

DTSException - if any error occurs in the method

getAllQualifierTypes

public QualifierType[] getAllQualifierTypes()
                                     throws DTSException

Retrieves all qualifier types.

Returns:

an array of all the QualifierTypes. Returns an empty array if there are no QualifierTypes.

Throws:

DTSException - if any error occurs in the method

getAllConceptPropertyQualifierTypes

public QualifierType[] getAllConceptPropertyQualifierTypes()
                                                    throws DTSException

Retrieves all concept property qualifier types.

Returns:

an array of all the concept property QualifierTypes. Returns an empty array if there are no concept property QualifierTypes.

Throws:

DTSException - if any error occurs in the method

getConceptPropertyQualifierTypes

public QualifierType[] getConceptPropertyQualifierTypes(int namespaceId)
                                                 throws DTSException

Retrieves all concept property qualifier types within a given namespace.

Parameters:

namespaceId - the ID of the namespace of interest

Returns:

an array of concept property QualifierTypes in the namespace. Returns an empty array if there are no concept property QualifierTypes.

Throws:

DTSException - if any error occurs in the method

getAllTermPropertyQualifierTypes

public QualifierType[] getAllTermPropertyQualifierTypes()
                                                 throws DTSException

Retrieves all term property qualifier types.

Returns:

an array of all the term property QualifierTypes. Returns an empty array if there are no term property QualifierTypes.

Throws:

DTSException - if any error occurs in the method

getTermPropertyQualifierTypes

public QualifierType[] getTermPropertyQualifierTypes(int namespaceId)
                                              throws DTSException

Retrieves all term property qualifier types within a given namespace.

Parameters:

namespaceId - the ID of the namespace of interest

Returns:

an array of term property QualifierTypes in the namespace. Returns an empty array if there are no term property QualifierTypes.

Throws:

DTSException - if any error occurs in the method

getAllConceptAssociationQualifierTypes

public QualifierType[] getAllConceptAssociationQualifierTypes()
                                                       throws DTSException

Retrieves all concept association qualifier types.

Returns:

an array of all the concept association QualifierTypes. Returns an empty array if there are no concept association QualifierTypes.

Throws:

DTSException - if any error occurs in the method

getConceptAssociationQualifierTypes

public QualifierType[] getConceptAssociationQualifierTypes(int namespaceId)
                                                    throws DTSException

Retrieves all concept association qualifier types within a given namespace.

Parameters:

namespaceId - the ID of the namespace of interest

Returns:

an array of concept association QualifierTypes in the namespace. Returns an empty array if there are no concept association QualifierTypes.

Throws:

DTSException - if any error occurs in the method

getAllTermAssociationQualifierTypes

public QualifierType[] getAllTermAssociationQualifierTypes()
                                                    throws DTSException

Retrieves all term association qualifier types.

Returns:

an array of all the term association QualifierTypes. Returns an empty array if there are no term association QualifierTypes.

Throws:

DTSException - if any error occurs in the method

getTermAssociationQualifierTypes

public QualifierType[] getTermAssociationQualifierTypes(int namespaceId)
                                                 throws DTSException

Retrieves all term association qualifier types within a given namespace.

Parameters:

namespaceId - the ID of the namespace of interest

Returns:

an array of term association QualifierTypes in the namespace. Returns an empty array if there are no term association QualifierTypes.

Throws:

DTSException - if any error occurs in the method

findQualifierTypeByName

public QualifierType findQualifierTypeByName(String termName,
                                             int namespaceId)
                                      throws DTSException

Gets the QualifierType object with the specified name and namespace ID.

Parameters:

termName - the QualifierType name

namespaceId - the QualifierType's namespace ID

Returns:

the QualifierType identified by the specified name and namespace, or null if not found

Throws:

DTSException - if any error occurs in the method

findQualifierTypeById

public QualifierType findQualifierTypeById(int termId,
                                           int namespaceId)
                                    throws DTSException

Gets the QualifierType object with the specified ID and namespace ID.

Parameters:

termId - the QualifierType ID

namespaceId - the QualifierType's namespace ID

Returns:

the QualifierType identified by the specified ID and namespace, or null if not found

Throws:

DTSException - if any error occurs in the method

findQualifierTypeByCode

public QualifierType findQualifierTypeByCode(String termCode,
                                             int namespaceId)
                                      throws DTSException

Gets the QualifierType object with the specified code and namespace ID.

Parameters:

termCode - the QualifierType code

namespaceId - the QualifierType's namespace ID

Returns:

the QualifierTypes identified by the specified code and namespace, or null if not found

Throws:

DTSException - if any error occurs in the method

fireKBTypeAction

protected void fireKBTypeAction(KBTypeEvent event)

getKBTypeListener

public KBTypeListener getKBTypeListener()

Get the KBTypeListener. This can be used to link the chain of kbtype listeners of this class to kbtype listener of another instance of QualifierTypeQuery.

Returns:

KBTypeListener

addKBTypeListener

public void addKBTypeListener(KBTypeListener listener)

removeKBTypeListener

public void removeKBTypeListener(KBTypeListener listener)