org.wsmo.grounding.sawsdl
Interface Grounding


public interface Grounding

A grounding object containing all SAWSDL annotations of a single WSDL document. Each model annotation is represented by a single ModelRef object which can not be shared with other groundings. The Grounding API offers a set of factory methods for creating the various types of semantic model references.


Method Summary
 void addGroundingChangeListener(GroundingChangeEventListener listener)
          Registers a grounding change listener to be notified when new model references and schema mappings are created or removed from this grounding object.
 AttributeModelRef createAttributeModelRef(QName attribute, org.wsmo.common.IRI target)
          Creates and includes in this grounding object a single model reference from an XML Schema attribute to a concept in a semantic model.
 ComplexTypeModelRef createComplexTypeModelRef(QName type, org.wsmo.common.IRI target)
          Creates and includes in this grounding object a single model reference from an XML Schema complexType to a concept in a semantic model.
 ElementModelRef createElementModelRef(QName element, org.wsmo.common.IRI target)
          Creates and includes in this grounding object a single model reference from an XML Schema element to a concept in a semantic model.
 FaultModelRef createFaultModelRef(QName fault, org.wsmo.common.IRI target)
          Creates and includes in this grounding object a single model reference from a WSDL operation fault to a concept in a semantic model.
 InterfaceCategory createInterfaceCategory(QName iface, org.wsmo.common.IRI target)
          Creates and includes in this grounding object a single model reference from a WSDL interface to a concept in a semantic model.
 LiftingSchemaMapping createLiftingSchemaMapping(QName source, URI schemaRef)
          Creates and includes in this grounding object a mapping to a transformation schema responsible for the lifting of the source entity to the corresponding semantic model entity.
 LoweringSchemaMapping createLoweringSchemaMapping(QName source, URI schemaRef)
          Creates and includes in this grounding object a mapping to a transformation schema responsible for the lowering to the source entity from the corresponding semantic model entity.
 OperationModelRef createOperationModelRef(QName operation, org.wsmo.common.IRI target)
          Creates and includes in this grounding object a single model reference from a WSDL operation to a concept in a semantic model.
 SimpleTypeModelRef createSimpleTypeModelRef(QName type, org.wsmo.common.IRI target)
          Creates and includes in this grounding object a single model reference from an XML Schema simpleType to a concept in a semantic model.
 List<ModelRef> listDeclaredModelRefs()
          Lists all (regardless of specific type) model references in this grounding object.
 List<ModelRef> listDeclaredModelRefs(QName source)
          Lists all model references for the specified WSDL or XML Schema entity in this grounding object.
 List<SchemaMapping> listDeclaredSchemaMappings()
          Lists all lifting and lowering schema mappings of this grounding object.
 List<SchemaMapping> listDeclaredSchemaMappings(QName source)
          Lists all lifting and lowering schema mappings for the source entity belonging to this grounding object.
 List<ModelRef> listModelRefs()
          Lists all (regardless of specific type) model references in this grounding object, including the propagated ones.
 List<ModelRef> listModelRefs(QName source)
          Lists all model references for the specified WSDL or XML Schema entity in this grounding object, including the propagated ones.
 List<SchemaMapping> listSchemaMappings()
          Lists all lifting and lowering schema mappings of this grounding object, including the propagated ones.
 List<SchemaMapping> listSchemaMappings(QName source)
          Lists all lifting and lowering schema mappings for the source entity belonging to this grounding object, including the propagated ones.
 void removeGroundingChangeListener(GroundingChangeEventListener listener)
          Unregisters a grounding change listener.
 void removeModelRef(ModelRef reference)
          Removes a single model reference from this grounding object.
 void removeSchemaMapping(SchemaMapping mapping)
          Removes a single lifting or lowering schema mapping from this grounding object.
 

Method Detail

createAttributeModelRef

AttributeModelRef createAttributeModelRef(QName attribute,
                                          org.wsmo.common.IRI target)
                                          throws org.wsmo.common.exception.InvalidModelException
Creates and includes in this grounding object a single model reference from an XML Schema attribute to a concept in a semantic model.

Parameters:
attribute - the name of the attribute to be annotated
target - the semantic model id reference
Returns:
A new attribute model reference
Throws:
org.wsmo.common.exception.InvalidModelException - if the supplied attribute name is not defined in the current WSDL document

createComplexTypeModelRef

ComplexTypeModelRef createComplexTypeModelRef(QName type,
                                              org.wsmo.common.IRI target)
                                              throws org.wsmo.common.exception.InvalidModelException
Creates and includes in this grounding object a single model reference from an XML Schema complexType to a concept in a semantic model.

Parameters:
type - the name of the complexType to be annotated
target - the semantic model id reference
Returns:
A new complexType model reference
Throws:
org.wsmo.common.exception.InvalidModelException - if the supplied complexType name is not defined in the current WSDL document

createSimpleTypeModelRef

SimpleTypeModelRef createSimpleTypeModelRef(QName type,
                                            org.wsmo.common.IRI target)
                                            throws org.wsmo.common.exception.InvalidModelException
Creates and includes in this grounding object a single model reference from an XML Schema simpleType to a concept in a semantic model.

Parameters:
type - the name of the simpleType to be annotated
target - the semantic model id reference
Returns:
A new simpleType model reference
Throws:
org.wsmo.common.exception.InvalidModelException - if the supplied simpleType name is not defined in the current WSDL document

createElementModelRef

ElementModelRef createElementModelRef(QName element,
                                      org.wsmo.common.IRI target)
                                      throws org.wsmo.common.exception.InvalidModelException
Creates and includes in this grounding object a single model reference from an XML Schema element to a concept in a semantic model.

Parameters:
element - the name of the element to be annotated
target - the semantic model id reference
Returns:
A new element model reference
Throws:
org.wsmo.common.exception.InvalidModelException - if the supplied element name is not defined in the current WSDL document

createInterfaceCategory

InterfaceCategory createInterfaceCategory(QName iface,
                                          org.wsmo.common.IRI target)
                                          throws org.wsmo.common.exception.InvalidModelException
Creates and includes in this grounding object a single model reference from a WSDL interface to a concept in a semantic model. This reference plays role of a classification property.

Parameters:
iface - the name of the interface to be annotated
target - the semantic model id reference
Returns:
A new interface category reference
Throws:
org.wsmo.common.exception.InvalidModelException - if the supplied interface name is not defined in the current WSDL document

createOperationModelRef

OperationModelRef createOperationModelRef(QName operation,
                                          org.wsmo.common.IRI target)
                                          throws org.wsmo.common.exception.InvalidModelException
Creates and includes in this grounding object a single model reference from a WSDL operation to a concept in a semantic model.

Parameters:
operation - the name of the operation to be annotated
target - the semantic model id reference
Returns:
A new operation model reference
Throws:
org.wsmo.common.exception.InvalidModelException - if the supplied operation name is not defined in the current WSDL document

createFaultModelRef

FaultModelRef createFaultModelRef(QName fault,
                                  org.wsmo.common.IRI target)
                                  throws org.wsmo.common.exception.InvalidModelException
Creates and includes in this grounding object a single model reference from a WSDL operation fault to a concept in a semantic model.

Parameters:
fault - the name of the operation fault to be annotated
target - the semantic model id reference
Returns:
A new fault model reference
Throws:
org.wsmo.common.exception.InvalidModelException - if the supplied operation fault name is not defined in the current WSDL document

removeModelRef

void removeModelRef(ModelRef reference)
                    throws org.wsmo.common.exception.InvalidModelException
Removes a single model reference from this grounding object.

Parameters:
reference - the model reference to be removed
Throws:
org.wsmo.common.exception.InvalidModelException - if the supplied reference does not belong to this grounding object

listDeclaredModelRefs

List<ModelRef> listDeclaredModelRefs()
Lists all (regardless of specific type) model references in this grounding object. Only the declared model references are listed, not the propagated ones.

Returns:
A list of model reference objects

listDeclaredModelRefs

List<ModelRef> listDeclaredModelRefs(QName source)
                                     throws org.wsmo.common.exception.InvalidModelException
Lists all model references for the specified WSDL or XML Schema entity in this grounding object. Only the declared model references are listed, not the propagated ones.

Parameters:
source - the name of the WSDL or XML Schema entity
Returns:
A list of model reference objects
Throws:
org.wsmo.common.exception.InvalidModelException - if the supplied entity name is not defined in the current WSDL document

listModelRefs

List<ModelRef> listModelRefs()
                             throws org.wsmo.common.exception.InvalidModelException
Lists all (regardless of specific type) model references in this grounding object, including the propagated ones.

Returns:
A list of model reference objects
Throws:
org.wsmo.common.exception.InvalidModelException - if the model is somehow inconsistent

listModelRefs

List<ModelRef> listModelRefs(QName source)
                             throws org.wsmo.common.exception.InvalidModelException
Lists all model references for the specified WSDL or XML Schema entity in this grounding object, including the propagated ones.

Parameters:
source - the name of the WSDL or XML Schema entity
Returns:
A list of model reference objects
Throws:
org.wsmo.common.exception.InvalidModelException - if the supplied entity name is not defined in the current WSDL document

createLiftingSchemaMapping

LiftingSchemaMapping createLiftingSchemaMapping(QName source,
                                                URI schemaRef)
                                                throws org.wsmo.common.exception.InvalidModelException
Creates and includes in this grounding object a mapping to a transformation schema responsible for the lifting of the source entity to the corresponding semantic model entity.

Parameters:
source - the name of the XML Schema entity
schemaRef - the identifier of the lifting schema
Returns:
A new lifting schema mapping
Throws:
org.wsmo.common.exception.InvalidModelException - if the supplied entity name is not defined in the current WSDL document

createLoweringSchemaMapping

LoweringSchemaMapping createLoweringSchemaMapping(QName source,
                                                  URI schemaRef)
                                                  throws org.wsmo.common.exception.InvalidModelException
Creates and includes in this grounding object a mapping to a transformation schema responsible for the lowering to the source entity from the corresponding semantic model entity.

Parameters:
source - the name of the XML Schema entity
schemaRef - the identifier of the lowering schema
Returns:
A new lowering schema mapping
Throws:
org.wsmo.common.exception.InvalidModelException - if the supplied entity name is not defined in the current WSDL document

removeSchemaMapping

void removeSchemaMapping(SchemaMapping mapping)
                         throws org.wsmo.common.exception.InvalidModelException
Removes a single lifting or lowering schema mapping from this grounding object.

Parameters:
mapping - the mapping object to be removed
Throws:
org.wsmo.common.exception.InvalidModelException - if the mapping object does not belong to this grounding object

listDeclaredSchemaMappings

List<SchemaMapping> listDeclaredSchemaMappings()
Lists all lifting and lowering schema mappings of this grounding object. Only the declared schema mappings are listed, not the propagated ones.

Returns:
A list of schema mappings

listDeclaredSchemaMappings

List<SchemaMapping> listDeclaredSchemaMappings(QName source)
                                               throws org.wsmo.common.exception.InvalidModelException
Lists all lifting and lowering schema mappings for the source entity belonging to this grounding object. Only the declared schema mappings are listed, not the propagated ones.

Returns:
A list of schema mappings
Throws:
org.wsmo.common.exception.InvalidModelException

listSchemaMappings

List<SchemaMapping> listSchemaMappings()
                                       throws org.wsmo.common.exception.InvalidModelException
Lists all lifting and lowering schema mappings of this grounding object, including the propagated ones.

Returns:
A list of schema mappings
Throws:
org.wsmo.common.exception.InvalidModelException - if the model is somehow inconsistent

listSchemaMappings

List<SchemaMapping> listSchemaMappings(QName source)
                                       throws org.wsmo.common.exception.InvalidModelException
Lists all lifting and lowering schema mappings for the source entity belonging to this grounding object, including the propagated ones.

Returns:
A list of schema mappings
Throws:
org.wsmo.common.exception.InvalidModelException

addGroundingChangeListener

void addGroundingChangeListener(GroundingChangeEventListener listener)
Registers a grounding change listener to be notified when new model references and schema mappings are created or removed from this grounding object.

Parameters:
listener -

removeGroundingChangeListener

void removeGroundingChangeListener(GroundingChangeEventListener listener)
Unregisters a grounding change listener.

Parameters:
listener -


Copyright © 2004-2008 Ontotext Lab.. All Rights Reserved.