com.apelon.dts.client.classifier
Class ClassifyDetailsQuery

java.lang.Object
  extended by com.apelon.apelonserver.client.BasicQuery
      extended by com.apelon.dts.client.classifier.ClassifyDetailsQuery

public abstract class ClassifyDetailsQuery
extends BasicQuery

In DTS, an Ontylog Extension namespace can be classified. This class can be used to get the details about classification for such a namespace.

It provides methods to retreive following details for a namespace:

  1. The classification monitor data; This includes, whether classification should be done and last classification time stamp.
  2. Cycle Errors
  3. Equivalency Errors
  4. Concepts with no kind

Copyright: Copyright (c) 2004

Company: Apelon, Inc.

Since:
DTS 3.3.0
Version:
DTS 3.3.0
Author:
Apelon, Inc.

Field Summary
 
Fields inherited from class com.apelon.apelonserver.client.BasicQuery
ADMIN, queryHeader
 
Constructor Summary
protected ClassifyDetailsQuery()
           
protected ClassifyDetailsQuery(boolean isValidating)
           
 
Method Summary
static ClassifyDetailsQuery createInstance(ServerConnection sc)
          Creates an instance of ClassifyDetailsQuery.
static ClassifyDetailsQuery createInstance(ServerConnection sc, boolean isValidating)
          Creates an instance of ClassifyDetailsQuery.
 ClassifyDetail getClassifyDetail(int namespaceId)
          This can be used to get the classification details for an Ontylog Extension namespace.
 ClassifyCycleError[] getCycleErrors(int namespaceId)
          This can be used to get the classification Cycle Errors for an Ontylog Extension namespace.
 ClassifyEquivError[] getEqErrors(int namespaceId)
          This can be used to get the classification Equivalency Errors for an Ontylog Extension namespace.
 OntylogConcept[] getNoKindConcepts(int namespaceId)
          This can be used to get the concepts with no Kind for an Ontylog Extension namespace.
 OntylogConcept[] getNoParentConcepts(int namespaceId)
          This can be used to get the concepts with no parent (defining concept) for an Ontylog Extension namespace.
 
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
 

Constructor Detail

ClassifyDetailsQuery

protected ClassifyDetailsQuery()

ClassifyDetailsQuery

protected ClassifyDetailsQuery(boolean isValidating)
Method Detail

createInstance

public static ClassifyDetailsQuery createInstance(ServerConnection sc)
                                           throws IllegalArgumentException
Creates an instance of ClassifyDetailsQuery. Depending on the type of ServerConnection object passed in the argument, the server may be local (JDBC), socket, or another implementation. When using a socket connection, the Apelon DTS server must be configured with the following query server to support ClassifyDetailsQuery: If you're using a JDBC connection, you'll need to add something like the following lines:
  ServerConnectionJDBC scJDBC = new ServerConnectionJDBC(user, password,
    host, port, instance);
  ClassifyDetailsQuery classifyDetailsQuery =
    ClassifyDetailsQuery.createInstance(scJDBC);
      sc.setQueryServer(Class.forName("com.apelon.dts.server.ClassifyDetailsServer"),
     DTSHeader.CLASSIFYDETAILSYQUERY_HEADER);

 

Parameters:
sc - the server connection
Returns:
the created ClassifyDetailsQuery
Throws:
IllegalArgumentException - if a null server connection is passed //it will be good to specify full qualified exception --CK
See Also:
ServerConnectionJDBC, ServerConnectionSocket, ServerConnectionSecureSocket

createInstance

public static ClassifyDetailsQuery createInstance(ServerConnection sc,
                                                  boolean isValidating)
                                           throws IllegalArgumentException
Creates an instance of ClassifyDetailsQuery. Depending on the type of ServerConnection object passed in the argument, the server may be local (JDBC), socket, or another implementation. When using a socket connection, the Apelon DTS server must be configured with the following query server to support ClassifyDetailsQuery: If you're using a JDBC connection, you'll need to add something like the following lines:
  ServerConnectionJDBC scJDBC = new ServerConnectionJDBC(user, password,
    host, port, instance);
  ClassifyDetailsQuery classifyDetailsQuery =
    ClassifyDetailsQuery.createInstance(scJDBC);
      sc.setQueryServer(Class.forName("com.apelon.dts.server.ClassifyDetailsServer"),
     DTSHeader.CLASSIFYDETAILSYQUERY_HEADER);

 

Parameters:
sc - the server connection
isValidating - true if XML needs to be validated, false otherwise.
Returns:
the created ClassifyDetailsQuery
Throws:
IllegalArgumentException - if a null server connection is passed
See Also:
ServerConnectionJDBC, ServerConnectionSocket, ServerConnectionSecureSocket

getClassifyDetail

public ClassifyDetail getClassifyDetail(int namespaceId)
                                 throws DTSException
This can be used to get the classification details for an Ontylog Extension namespace.

Parameters:
namespaceId - ID of the namespace for which to get the classification details.
Returns:
Classification Details for an Ontylog Extension namespace, else null
Throws:
DTSException - For any error
See Also:
//specify full qualified class path name --CK

getCycleErrors

public ClassifyCycleError[] getCycleErrors(int namespaceId)
                                    throws DTSException
This can be used to get the classification Cycle Errors for an Ontylog Extension namespace.

Parameters:
namespaceId - ID of the namespace for which to get the classification Cycle Errors.
Returns:
Array of cycle errors if it is available, else empty array.
Throws:
DTSException - For any error
See Also:
ClassifyCycleError

getEqErrors

public ClassifyEquivError[] getEqErrors(int namespaceId)
                                 throws DTSException
This can be used to get the classification Equivalency Errors for an Ontylog Extension namespace.

Parameters:
namespaceId - ID of the namespace for which to get the classification Equivalency Errors.
Returns:
Array of equivalency errors if it is available, else empty array.
Throws:
DTSException - For any error
See Also:
//specify full qualified class path name --CK

getNoKindConcepts

public OntylogConcept[] getNoKindConcepts(int namespaceId)
                                   throws DTSException
This can be used to get the concepts with no Kind for an Ontylog Extension namespace.

Parameters:
namespaceId - ID of the namespace for which to get the concepts with no Kind.
Returns:
Array of concepts if it is available, else empty array.
Throws:
DTSException - For any error
See Also:
//specify full qualified class path name --CK

getNoParentConcepts

public OntylogConcept[] getNoParentConcepts(int namespaceId)
                                     throws DTSException
This can be used to get the concepts with no parent (defining concept) for an Ontylog Extension namespace.

Parameters:
namespaceId - ID of the namespace for which to get the concepts with no defining concept.
Returns:
Array of concepts if it is available, else empty array.
Throws:
DTSException - For any error
See Also:
//specify full qualified class path name --CK


Copyright © 2011. All Rights Reserved.