jsdai.lang
Interface QuerySource

All Known Subinterfaces:

Aggregate

All Known Implementing Classes:

jsdai.lang.A_primitive, CAggregate, SchemaInstance, SdaiModel, SdaiRepository, SdaiSession, jsdai.lang.SessionAggregate

public interface QuerySource

This interface is a query source according to "ISO 10303-22::9.3.12 query_source" It defines the source of a query execution. In the current JSDAI version it is supported only for local queries. This interface should not be considered stable.

Method Summary

ASdaiModel	getQuerySourceDomain() Returns domain in which to perform a search.
jsdai.query.SerializableRef	getQuerySourceDomainRef()
jsdai.query.SerializableRef	getQuerySourceInstanceRef()
AEntity	getQuerySourceInstances() Returns starting instances which serve as the first input instance set for a query.
int	query(java.lang.String where, EEntity entity, AEntity result) SDAI query according to part 22.

Method Detail

query

public int query(java.lang.String where,
                 EEntity entity,
                 AEntity result)
          throws SdaiException

SDAI query according to part 22.

This method is not implemented. SdaiException FN_NAVL will be thrown if this method is invoked.

Parameters:

where - a String value

entity - an EEntity value

result - an AEntity value

Returns:

an int value

Throws:

SdaiException - FN_NAVL, function not available.

See Also:

"ISO 10303-22::10.4.14 SDAI query"

getQuerySourceDomain

public ASdaiModel getQuerySourceDomain()
                                throws SdaiException

Returns domain in which to perform a search.

Returns:

ASdaiModel containing the domain

Throws:

SdaiException - if an error occurs during the operation or in underlying JSDAI operations

getQuerySourceInstances

public AEntity getQuerySourceInstances()
                                throws SdaiException

Returns starting instances which serve as the first input instance set for a query.

Returns:

AEntity containing the instances or null this aggregate consists all instances in query source domain

Throws:

SdaiException - if an error occurs during the operation or in underlying JSDAI operations

getQuerySourceInstanceRef

public jsdai.query.SerializableRef getQuerySourceInstanceRef()
                                                      throws SdaiException

Throws:

SdaiException

Since:

3.6.0

getQuerySourceDomainRef

public jsdai.query.SerializableRef getQuerySourceDomainRef()
                                                    throws SdaiException

Throws:

SdaiException

Since:

3.6.0