|
|
| (10 intermediate revisions by the same user not shown) |
| Line 20: |
Line 20: |
| | | | |
| | == Outline == | | == Outline == |
| − |
| |
| − |
| |
| − |
| |
| − |
| |
| − |
| |
| − |
| |
| | | | |
| | | | |
| | == Content == | | == Content == |
| | | | |
| − | | + | The content of this document has been merged with http://wiki.eclipse.org/COSMOS_DG_Constructing_a_Data_Manager |
| − | | + | |
| − | = Creating the Student Teacher Project =
| + | |
| − | | + | |
| − | Follow the instructions below to create an MDR project for the Student-Teacher sample:
| + | |
| − | | + | |
| − | # Click <b> File > New > Project </b>
| + | |
| − | # Expand <b> Web </b> and select <b> Dynamic Web Project </b>
| + | |
| − | # Click <b>Next</b> and type in <b>org.eclipse.cosmos.example.mdr</b> as the project name
| + | |
| − | # In the Target Runtime field, select the Apache Tomcat server where you want to deploy the data manager project. If a Tomcat server is not already defined, click <b>New...</b> to select a server runtime environment.
| + | |
| − | # After you define and select a target runtime for Apache Tomcat, the configuration "Default Configuration for Apache Tomcat v5.5" will be available for selection. Follow the steps below to configure the project:
| + | |
| − | ## Select the configuration and click the <b>Modify...</b> button. The Project Facets dialog will open.
| + | |
| − | ## Select the <b>Axis2 Web Services</b> facet category. Axis2 is the web services implementation used by COSMOS to deploy MDRs to a J2EE container.
| + | |
| − | ## Under the <b>Systems Management</b> category, select <b>CMDBf query service</b> to implement an MDR with a query service. For the purpose of the Teacher-Student sample we will not need the registration service. Any MDR intending to provide a CMDBf registration service would also select the second option under <b>System Management</b>.
| + | |
| − | ## Press OK to complete the configuration.
| + | |
| − | # Click <b>Next</b> twice to skip to the <b>MDR Configuration</b> page
| + | |
| − | # Enter <b>org.eclipse.cosmos.example.mdr</b> as the package name and <b>StudentTeacherSample</b> as the MDR name
| + | |
| − | # Click <b>Finish</b> to create the project
| + | |
| − | | + | |
| − | = Providing CMDBf Query Support =
| + | |
| − | | + | |
| − | As described in the previous section, the [http://www.cmdbf.org CMDBf specification] defines a query and a registration service. COSMOS provides a set of reusable, extensible classes and interfaces that can be utilized in implementing such services. This section will cover how COSMOS APIs can be used in providing a CMDBf query implementation for the Student-Teacher example.
| + | |
| − | | + | |
| − | | + | |
| − | == Architecture ==
| + | |
| − | | + | |
| − | The process of handling a CMDBf query involves traversing a structure representing the request, processing each individual part, and generating a structure representing the result. COSMOS has already defined structures representing the request and response. There is also generic code in place for traversing the request and invoking handlers for individual part of the CMDBf request. A consumer needs to only provide implementation of such handlers as part of implementing the query service.
| + | |
| − | | + | |
| − | A handler is required to process each CMDBf query constraint that an implementation supports. In addition to constraint handlers, the framework also requires two handlers for item templates and relationship templates. Here's the order in which the handlers are invoked:
| + | |
| − | | + | |
| − | # Item/Relationship template handler
| + | |
| − | # Instance id constraint handler
| + | |
| − | # Record type constraint handler
| + | |
| − | # Property value constraint handler
| + | |
| − | | + | |
| − | OR
| + | |
| − | | + | |
| − | # Item/Relationship template handler
| + | |
| − | # XPath constraint handler
| + | |
| − | | + | |
| − | It is the responsibility of the handler factory class to create instances of each handler above. The MDR toolkit automatically generates a handler factory. See src/org.eclipse.cosmos.example.mdr.handlers.QueryHandlerFactory.java for the class generated.
| + | |
| − | | + | |
| − | == Implementing Query Handlers ==
| + | |
| − | | + | |
| − | This sample will provide four handlers in total:
| + | |
| − | | + | |
| − | # An item template handler
| + | |
| − | # An instance id constraint handler
| + | |
| − | # A record type constraint handler
| + | |
| − | # A relationship handler
| + | |
| − | | + | |
| − | <b>Create</b> the following classes for each handler under src/org.eclipse.cosmos.example.mdr.handlers:
| + | |
| − | | + | |
| − | # ItemTemplateHandler
| + | |
| − | # ItemInstanceIdHandler
| + | |
| − | # ItemRecordTypeHandler.java
| + | |
| − | # RelationshipTemplateHandler.java
| + | |
| − | | + | |
| − | In addition to the four classes above, create an interface called "ICMDBfSampleConstants" under the same package to contain constants commonly used between handlers. The content of the interface appears below:
| + | |
| − | <pre>
| + | |
| − | package org.eclipse.cosmos.example.mdr.handlers;
| + | |
| − | | + | |
| − | /**
| + | |
| − | * Constants used by this CMDBf query sample
| + | |
| − | */
| + | |
| − | public interface ICMDBfSampleConstants
| + | |
| − | {
| + | |
| − | /**
| + | |
| − | * The key for the data provider that will be
| + | |
| − | * stored in the initialization data of the constraint
| + | |
| − | * handlers
| + | |
| − | */
| + | |
| − | public static final String DATA_PROVIDER = "org.eclipse.cosmos.samples.cmdbf.services.query.ICMDBfSampleConstants";
| + | |
| − | }
| + | |
| − | </pre>
| + | |
| − | | + | |
| − | <b>ItemTemplateHandler</b> is there to simply process item templates that do not contain any constraints. The content of the class appears below:
| + | |
| − | | + | |
| − | <pre>
| + | |
| − | package org.eclipse.cosmos.example.mdr.handlers;
| + | |
| − | | + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.common.CMDBfServiceException;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.query.service.impl.AbstractItemTemplateHandler;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.query.transform.response.artifacts.IItemConvertible;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.query.transform.response.artifacts.INodes;
| + | |
| − | | + | |
| − | /**
| + | |
| − | * An item template handler is invoked prior to invoking any constraint handler
| + | |
| − | * for item templates.
| + | |
| − | */
| + | |
| − | public class ItemTemplateHandler extends AbstractItemTemplateHandler
| + | |
| − | {
| + | |
| − | | + | |
| − | /**
| + | |
| − | * This method is only invoked if there are no constraints included in an
| + | |
| − | * item template.
| + | |
| − | *
| + | |
| − | * @param nodes The nodes element to append items to
| + | |
| − | */
| + | |
| − | protected void appendAllItems(INodes nodes) throws CMDBfServiceException
| + | |
| − | {
| + | |
| − | XMLRepository repo = (XMLRepository)getValue(ICMDBfSampleConstants.DATA_PROVIDER);
| + | |
| − | addItems(nodes, repo.classes);
| + | |
| − | addItems(nodes, repo.students);
| + | |
| − | addItems(nodes, repo.teachers);
| + | |
| − | }
| + | |
| − | | + | |
| − |
| + | |
| − | /**
| + | |
| − | * A convenient method used to add individual nodes to the
| + | |
| − | * INodes instance passed in.
| + | |
| − | *
| + | |
| − | * @param nodes Container for individual nodes
| + | |
| − | * @param itemConvertibles Elements that are convertible to an Item
| + | |
| − | */
| + | |
| − | private void addItems(INodes nodes, IItemConvertible[] itemConvertibles)
| + | |
| − | {
| + | |
| − | for (int i = 0; i < itemConvertibles.length; i++)
| + | |
| − | {
| + | |
| − | nodes.addItem(itemConvertibles[i].toItem(nodes));
| + | |
| − | }
| + | |
| − | }
| + | |
| − | }
| + | |
| − | </pre>
| + | |
| − | | + | |
| − | The instance id constraint is used to locate items based on the id attribute of the student/teacher element or the course code defined for a class element. The implementation simply walks through students, teachers, and classes to locate items that match the instance id constraint. The content of <b>ItemInstanceIdHandler</b> appears below:
| + | |
| − | | + | |
| − | <pre>
| + | |
| − | package org.eclipse.cosmos.example.mdr.handlers;
| + | |
| − | | + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.common.CMDBfServiceException;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.query.service.impl.AbstractItemConstraintHandler;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.query.transform.input.artifacts.IConstraint;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.query.transform.input.artifacts.IInstanceIdConstraint;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.query.transform.response.artifacts.INodes;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.query.transform.response.artifacts.QueryOutputArtifactFactory;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.transform.artifacts.IInstanceId;
| + | |
| − | import org.eclipse.cosmos.example.mdr.handlers.XMLRepository.SchoolMember;
| + | |
| − | | + | |
| − | /**
| + | |
| − | * This is the handler class for instance id constraints included
| + | |
| − | * in item templates. Adopters can either provide a direct implementation of
| + | |
| − | * IItemConstraintHandler or extend AbstractItemConstraintHandler
| + | |
| − | */
| + | |
| − | public class ItemInstanceIdHandler extends AbstractItemConstraintHandler
| + | |
| − | {
| + | |
| − | @Override
| + | |
| − | protected INodes handle(INodes context, IConstraint constraint) throws CMDBfServiceException
| + | |
| − | {
| + | |
| − | INodes result = QueryOutputArtifactFactory.getInstance().createNodes(context.getId());
| + | |
| − | IInstanceIdConstraint instanceIdConstraint = (IInstanceIdConstraint)constraint;
| + | |
| − | IInstanceId[] instanceIds = instanceIdConstraint.getInstanceIds();
| + | |
| − | for (int i = 0; i < instanceIds.length; i++) {
| + | |
| − | if (!XMLRepository.MDR_ID.equals(instanceIds[i].getMdrId()
| + | |
| − | .toString())) {
| + | |
| − | continue;
| + | |
| − | }
| + | |
| − | String localId = instanceIds[i].getLocalId().toString();
| + | |
| − | XMLRepository repo = (XMLRepository) getValue(ICMDBfSampleConstants.DATA_PROVIDER);
| + | |
| − | // Traverse the students
| + | |
| − | traverseSchoolMembers(result, localId, repo.students);
| + | |
| − | // Traverse the teachers
| + | |
| − | traverseSchoolMembers(result, localId, repo.teachers);
| + | |
| − | // Traverse the classes
| + | |
| − | for (int j = 0; j < repo.classes.length; j++)
| + | |
| − | {
| + | |
| − | if (localId.equals(repo.classes[j].courseCode))
| + | |
| − | {
| + | |
| − | result.addItem(repo.classes[j]);
| + | |
| − | }
| + | |
| − | }
| + | |
| − | }
| + | |
| − | return result;
| + | |
| − | }
| + | |
| − |
| + | |
| − | private void traverseSchoolMembers (INodes result, String localId, SchoolMember[] members)
| + | |
| − | {
| + | |
| − | for (int i = 0; i < members.length; i++)
| + | |
| − | {
| + | |
| − | if (localId.equals(members[i].identity.id))
| + | |
| − | {
| + | |
| − | result.addItem(members[i]);
| + | |
| − | }
| + | |
| − | }
| + | |
| − | }
| + | |
| − | }
| + | |
| − | </pre>
| + | |
| − | | + | |
| − | Similarly, ItemRecordTypeHandler is used to process record type constraints. The handler supports three record types: students, teachers, and class. The content of <b>ItemRecordTypeHandler</b> appears below:
| + | |
| − | | + | |
| − | <pre>
| + | |
| − | package org.eclipse.cosmos.example.mdr.handlers;
| + | |
| − | | + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.common.CMDBfServiceException;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.query.service.IItemConstraintHandler;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.query.service.impl.AbstractItemConstraintHandler;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.query.transform.input.artifacts.IConstraint;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.query.transform.input.artifacts.IRecordType;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.query.transform.response.artifacts.INodes;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.query.transform.response.artifacts.QueryOutputArtifactFactory;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.transform.artifacts.IGraphElement;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.transform.artifacts.IItem;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.transform.artifacts.IRecord;
| + | |
| − | import org.eclipse.cosmos.example.mdr.handlers.XMLRepository.ClassSession;
| + | |
| − | import org.eclipse.cosmos.example.mdr.handlers.XMLRepository.SchoolMember;
| + | |
| − | import org.eclipse.cosmos.example.mdr.handlers.XMLRepository.Student;
| + | |
| − | import org.eclipse.cosmos.example.mdr.handlers.XMLRepository.Teacher;
| + | |
| − | | + | |
| − | /**
| + | |
| − | * This is the handler for the record type constraint specified in
| + | |
| − | * and item template. Adopters can either extend AbstractItemConstraintHandler
| + | |
| − | * or provide a direct implementation of {@link IItemConstraintHandler}
| + | |
| − | */
| + | |
| − | public class ItemRecordTypeHandler extends AbstractItemConstraintHandler
| + | |
| − | {
| + | |
| − | /**
| + | |
| − | * Record type representing student
| + | |
| − | */
| + | |
| − | private static final String RECORD_TYPE_STUDENT = "student";
| + | |
| − |
| + | |
| − | /**
| + | |
| − | * Record type representing teacher
| + | |
| − | */
| + | |
| − | private static final String RECORD_TYPE_TEACHER = "teacher";
| + | |
| − |
| + | |
| − | /**
| + | |
| − | * Record type representing class
| + | |
| − | */
| + | |
| − | private static final String RECORD_TYPE_CLASS = "class";
| + | |
| − |
| + | |
| − | | + | |
| − | @Override
| + | |
| − | protected INodes handle(INodes context, IConstraint constraint) throws CMDBfServiceException
| + | |
| − | {
| + | |
| − | IRecordType recordType = (IRecordType)constraint;
| + | |
| − | String localName = recordType.getLocalName();
| + | |
| − | XMLRepository repo = (XMLRepository)getValue(ICMDBfSampleConstants.DATA_PROVIDER);
| + | |
| − | INodes result = QueryOutputArtifactFactory.getInstance().createNodes(context.getId());
| + | |
| − |
| + | |
| − | // If the record type constraint includes all items as its context
| + | |
| − | if (context.isStartingContext())
| + | |
| − | {
| + | |
| − | if (RECORD_TYPE_STUDENT.equals(localName))
| + | |
| − | {
| + | |
| − | addSchoolMembers(result, repo.students);
| + | |
| − | }
| + | |
| − | else if (RECORD_TYPE_TEACHER.equals(localName))
| + | |
| − | {
| + | |
| − | addSchoolMembers(result, repo.teachers);
| + | |
| − | }
| + | |
| − | else if (RECORD_TYPE_CLASS.equals(localName))
| + | |
| − | {
| + | |
| − | for (int i = 0; i < repo.classes.length; i++)
| + | |
| − | {
| + | |
| − | result.addItem(repo.classes[i]);
| + | |
| − | }
| + | |
| − | }
| + | |
| − |
| + | |
| − | return result;
| + | |
| − | }
| + | |
| − |
| + | |
| − | IGraphElement[] elements = context.getElements();
| + | |
| − | for (int i = 0; i < elements.length; i++)
| + | |
| − | {
| + | |
| − | IRecord[] records = elements[i].getRecords();
| + | |
| − | for (int j = 0; j < records.length; j++)
| + | |
| − | {
| + | |
| − | if (RECORD_TYPE_STUDENT.equals(localName) && records[j].getValue() instanceof Student)
| + | |
| − | {
| + | |
| − | result.addItem((IItem)elements[i]);
| + | |
| − | continue;
| + | |
| − | }
| + | |
| − | else if (RECORD_TYPE_TEACHER.equals(localName) && records[j].getValue() instanceof Teacher)
| + | |
| − | {
| + | |
| − | result.addItem((IItem)elements[i]);
| + | |
| − | continue;
| + | |
| − | }
| + | |
| − | else if (RECORD_TYPE_CLASS.equals(localName) && records[j].getValue() instanceof ClassSession)
| + | |
| − | {
| + | |
| − | result.addItem((IItem)elements[i]);
| + | |
| − | continue;
| + | |
| − | }
| + | |
| − | }
| + | |
| − | }
| + | |
| − |
| + | |
| − | return result;
| + | |
| − | }
| + | |
| − | | + | |
| − | private void addSchoolMembers(INodes result, SchoolMember[] members)
| + | |
| − | {
| + | |
| − | for (int i = 0; i < members.length; i++)
| + | |
| − | {
| + | |
| − | result.addItem(members[i]);
| + | |
| − | }
| + | |
| − | }
| + | |
| − | }
| + | |
| − | </pre>
| + | |
| − | | + | |
| − | Finally, RelationshipTemplateHandler is used to process one type of relationships: i.e. the relationship between a teacher and a student. Given that there is only one type of relationship defined, the input is processed in a relationship template handler. Typically this type of a relationship would be defined in a record type constraint for relationship templates. The class always assumes that the source is a teacher and the target is a student. The relationship is always teacher X teaches student Y. The code for <b>RelationshipTemplateHandler </b> appears below:
| + | |
| − | | + | |
| − | <pre>
| + | |
| − | package org.eclipse.cosmos.example.mdr.handlers;
| + | |
| − | | + | |
| − | import java.util.ArrayList;
| + | |
| − | import java.util.List;
| + | |
| − | | + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.common.CMDBfServiceException;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.query.service.IRelationshipTemplateHandler;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.query.service.impl.AbstractQueryHandler;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.query.transform.input.artifacts.IRelationshipTemplate;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.query.transform.response.artifacts.IEdges;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.query.transform.response.artifacts.IQueryResult;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.query.transform.response.artifacts.QueryOutputArtifactFactory;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.transform.artifacts.IItem;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.transform.artifacts.IRecord;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.transform.artifacts.IRelationship;
| + | |
| − | import org.eclipse.cosmos.example.mdr.handlers.XMLRepository.ClassSession;
| + | |
| − | import org.eclipse.cosmos.example.mdr.handlers.XMLRepository.Student;
| + | |
| − | import org.eclipse.cosmos.example.mdr.handlers.XMLRepository.Teacher;
| + | |
| − | | + | |
| − | /**
| + | |
| − | * Represents the relationship record type handler. There is only one type
| + | |
| − | * of relationship that this handler accepts: "teaches". The "teaches"
| + | |
| − | * relationship can only exist between a teacher A and a student B (i.e.
| + | |
| − | * A teaches B).
| + | |
| − | * Adopters can either extend AbstractRelationshipConstraintHandler or provide
| + | |
| − | * a direct implementation of IRelationshipConstraintHandler
| + | |
| − | */
| + | |
| − | public class RelationshipTemplateHandler extends AbstractQueryHandler implements IRelationshipTemplateHandler
| + | |
| − | {
| + | |
| − | public IEdges execute(IQueryResult context, IRelationshipTemplate relationshipTemplate, IItem source, IItem target) throws CMDBfServiceException
| + | |
| − | {
| + | |
| − | IEdges results = QueryOutputArtifactFactory.getInstance().createEdges(relationshipTemplate);
| + | |
| − | IRecord[] sourceRecords = source.getRecords();
| + | |
| − | IRecord[] targetRecords = target.getRecords();
| + | |
| − |
| + | |
| − | // Only one record is expected
| + | |
| − | if (sourceRecords.length != 1 || targetRecords.length != 1)
| + | |
| − | {
| + | |
| − | return results;
| + | |
| − | }
| + | |
| − |
| + | |
| − | if (sourceRecords[0].getValue() instanceof Teacher && targetRecords[0].getValue() instanceof Student)
| + | |
| − | {
| + | |
| − | XMLRepository repo = (XMLRepository)getValue(ICMDBfSampleConstants.DATA_PROVIDER);
| + | |
| − | String teacherId = ((Teacher)sourceRecords[0].getValue()).identity.id;
| + | |
| − | String studentId = ((Student)targetRecords[0].getValue()).identity.id;
| + | |
| − |
| + | |
| − | ClassSession[] classSessions = findClass (repo, teacherId, studentId);
| + | |
| − | for (int i = 0; i < classSessions.length; i++)
| + | |
| − | {
| + | |
| − | IRelationship relationship = classSessions[i].toRelationship(results);
| + | |
| − | relationship.setSourceId(QueryOutputArtifactFactory.getInstance().createInstanceId(XMLRepository.MDR_ID, teacherId));
| + | |
| − | relationship.setTargetId(QueryOutputArtifactFactory.getInstance().createInstanceId(XMLRepository.MDR_ID, studentId));
| + | |
| − | results.addRelationship(relationship);
| + | |
| − | }
| + | |
| − | }
| + | |
| − |
| + | |
| − | return results;
| + | |
| − | }
| + | |
| − |
| + | |
| − | private ClassSession[] findClass(XMLRepository repo, String teacherId, String studentId)
| + | |
| − | {
| + | |
| − | List<ClassSession> discoveredClasses = new ArrayList<ClassSession>();
| + | |
| − | ClassSession[] classes = repo.classes;
| + | |
| − | for (int i = 0; i < classes.length; i++)
| + | |
| − | {
| + | |
| − | if (teacherId.equals(classes[i].teacher.identity.id))
| + | |
| − | {
| + | |
| − | Student[] students = classes[i].students;
| + | |
| − | for (int j = 0; j < students.length; j++)
| + | |
| − | {
| + | |
| − | if (studentId.equals(students[j].identity.id))
| + | |
| − | {
| + | |
| − | discoveredClasses.add(classes[i]);
| + | |
| − | }
| + | |
| − | }
| + | |
| − | }
| + | |
| − | }
| + | |
| − |
| + | |
| − | return discoveredClasses.toArray(new ClassSession[discoveredClasses.size()]);
| + | |
| − | }
| + | |
| − | }
| + | |
| − | </pre>
| + | |
| − | | + | |
| − | This completes the implementation for all supported query handlers. What remains to be done is the factory class to instantiate instances of each handler. Open the generated class org.eclipse.cosmos.example.mdr.handlers.QueryHandlerFactory and add the following content:
| + | |
| − | | + | |
| − | <pre>
| + | |
| − | package org.eclipse.cosmos.example.mdr.handlers;
| + | |
| − | | + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.common.CMDBfServiceException;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.query.service.IItemConstraintHandler;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.query.service.IItemTemplateHandler;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.query.service.IRelationshipTemplateHandler;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.query.service.impl.AbstractQueryHandlerFactory;
| + | |
| − | | + | |
| − | /**
| + | |
| − | * This factory class is used to create handlers for the selectors
| + | |
| − | * that are applicable to the XML repository MDR. Adopters can either
| + | |
| − | * extend AbstractSelectorHandlerFactory or provide a direct
| + | |
| − | * implementation of ISelectorHandlerFactory
| + | |
| − | */
| + | |
| − | public class QueryHandlerFactory extends AbstractQueryHandlerFactory
| + | |
| − | {
| + | |
| − | private static QueryHandlerFactory instance;
| + | |
| − |
| + | |
| − | /**
| + | |
| − | * Make the constructor invisible
| + | |
| − | */
| + | |
| − | private QueryHandlerFactory()
| + | |
| − | {
| + | |
| − | }
| + | |
| − |
| + | |
| − | public static QueryHandlerFactory getInstance()
| + | |
| − | {
| + | |
| − | if (instance == null)
| + | |
| − | {
| + | |
| − | instance = new QueryHandlerFactory();
| + | |
| − | }
| + | |
| − | return instance;
| + | |
| − | }
| + | |
| − |
| + | |
| − | @Override
| + | |
| − | protected IItemConstraintHandler createItemInstanceHandler()
| + | |
| − | {
| + | |
| − | return new ItemInstanceIdHandler();
| + | |
| − | }
| + | |
| − |
| + | |
| − | @Override
| + | |
| − | protected IItemConstraintHandler createItemRecordHandler()
| + | |
| − | {
| + | |
| − | return new ItemRecordTypeHandler();
| + | |
| − | }
| + | |
| − |
| + | |
| − | @Override
| + | |
| − | protected IItemTemplateHandler createItemHandler() throws CMDBfServiceException
| + | |
| − | {
| + | |
| − | return new ItemTemplateHandler();
| + | |
| − | }
| + | |
| − |
| + | |
| − | @Override
| + | |
| − | protected IRelationshipTemplateHandler createRelationshipHandler() throws CMDBfServiceException
| + | |
| − | {
| + | |
| − | return new RelationshipTemplateHandler();
| + | |
| − | }
| + | |
| − | }
| + | |
| − | </pre>
| + | |
| − | | + | |
| − | == Testing the Query Service ==
| + | |
| − | | + | |
| − | The easiest way of testing a query service for an MDR is through JUnits. This section demonstrates how the query service can be tested independently from other COSMOS components. The code included in this section can easily be incorporated in a JUnit to automatically test the results against an expected outcome. Follow the instructions below to test the query service:
| + | |
| − | | + | |
| − | # Create a query request under org.eclipse.cosmos.example.mdr/src called <b>teaches-relationship.xml</b>
| + | |
| − | # Create a new class called <b>QueryLauncher</b> under the same package as the handlers (i.e. org.eclipse.cosmos.example.mdr.handlers).
| + | |
| − | | + | |
| − | Use the content below for the query request. This file queries for all students that are taught by teacher staff01.
| + | |
| − | <pre>
| + | |
| − | | + | |
| − | <?xml version="1.0" encoding="UTF-8"?>
| + | |
| − | | + | |
| − | <!-- This query selects all students taught by the teacher with -->
| + | |
| − | <!-- the id: "staff01" -->
| + | |
| − | <s:query xmlns:s="http://cmdbf.org/schema/1-0-0/datamodel">
| + | |
| − | <s:itemTemplate id="teacher">
| + | |
| − | <s:instanceIdConstraint>
| + | |
| − | <s:instanceId>
| + | |
| − | <s:mdrId>org.eclipse.cosmos.samples.cmdbf.XMLRepository</s:mdrId>
| + | |
| − | <s:localId>staff01</s:localId>
| + | |
| − | </s:instanceId>
| + | |
| − | </s:instanceIdConstraint>
| + | |
| − | </s:itemTemplate>
| + | |
| − |
| + | |
| − | <s:itemTemplate id="students">
| + | |
| − | <s:recordConstraint>
| + | |
| − | <s:recordType namespace="" localName="student"/>
| + | |
| − | </s:recordConstraint>
| + | |
| − | </s:itemTemplate>
| + | |
| − |
| + | |
| − | <s:relationshipTemplate id="reference">
| + | |
| − | <s:sourceTemplate ref="teacher"/>
| + | |
| − | <s:targetTemplate ref="students"/>
| + | |
| − | </s:relationshipTemplate>
| + | |
| − | </s:query>
| + | |
| − | | + | |
| − | </pre>
| + | |
| − | | + | |
| − | Here's the content for <b>QueryLauncer</b>. The main method simply uses the content of teaches-relationship.xml to submit a CMDBf query:
| + | |
| − | | + | |
| − | <pre>
| + | |
| − | package org.eclipse.cosmos.example.mdr.handlers;
| + | |
| − | | + | |
| − | | + | |
| − | import java.io.IOException;
| + | |
| − | import java.io.InputStream;
| + | |
| − | import java.net.URISyntaxException;
| + | |
| − | import java.util.Hashtable;
| + | |
| − | import java.util.Map;
| + | |
| − | | + | |
| − | import javax.xml.parsers.ParserConfigurationException;
| + | |
| − | | + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.common.CMDBfServiceException;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.query.service.impl.CMDBfQueryOperation;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.query.transform.QueryOutputTransformer;
| + | |
| − | import org.eclipse.cosmos.dc.cmdbf.services.query.transform.response.artifacts.IQueryResult;
| + | |
| − | import org.xml.sax.SAXException;
| + | |
| − | | + | |
| − | /**
| + | |
| − | * The main class used to run the CMDBf queries. A set of query
| + | |
| − | * files exist under the source directory. Adjust the queryFile field to
| + | |
| − | * run the correct CMDBf query.
| + | |
| − | */
| + | |
| − | public class QueryLauncher
| + | |
| − | {
| + | |
| − | private static final String queryFile = "teaches-relationship.xml";
| + | |
| − |
| + | |
| − | | + | |
| − | public static void main(String[] args) throws ParserConfigurationException, SAXException, IOException, IllegalArgumentException, URISyntaxException, CMDBfServiceException
| + | |
| − | {
| + | |
| − | // Run the query
| + | |
| − | InputStream query = QueryLauncher.class.getClassLoader().getResourceAsStream(queryFile);
| + | |
| − | CMDBfQueryOperation queryOperation = new CMDBfQueryOperation(QueryHandlerFactory.getInstance(), null);
| + | |
| − | Map<String, Object> init = new Hashtable<String, Object>();
| + | |
| − | init.put(ICMDBfSampleConstants.DATA_PROVIDER, new XMLRepository());
| + | |
| − | queryOperation.initialize(init);
| + | |
| − | IQueryResult result = queryOperation.execute(query);
| + | |
| − |
| + | |
| − | // Transform and output the query
| + | |
| − | InputStream resultStream = QueryOutputTransformer.transform(result);
| + | |
| − | byte[] buffer = new byte[1024];
| + | |
| − | while (resultStream.available() > 0)
| + | |
| − | {
| + | |
| − | int chars = resultStream.read(buffer);
| + | |
| − | System.out.print(new String(buffer, 0, chars));
| + | |
| − | }
| + | |
| − | }
| + | |
| − | | + | |
| − | }
| + | |
| − | | + | |
| − | </pre>
| + | |
| − | | + | |
| − | Once executed, the output of the query should be printed out to the console. The output will look something similar to:
| + | |
| − | | + | |
| − | <pre>
| + | |
| − | <cmdbf:queryResult xmlns:cmdbf="http://cmdbf.org/schema/1-0-0/datamodel">
| + | |
| − | <cmdbf:nodes templateId="teacher">
| + | |
| − | <cmdbf:item>
| + | |
| − | <cmdbf:record xmlns="http://school">
| + | |
| − | | + | |
| − | <teacher>
| + | |
| − | <identity firstName="Dawn" lastName="Johnson" id="staff01"/>
| + | |
| − | </teacher>
| + | |
| − | | + | |
| − | <cmdbf:recordMetadata>
| + | |
| − | <cmdbf:recordId>staff01</cmdbf:recordId>
| + | |
| − | </cmdbf:recordMetadata>
| + | |
| − | </cmdbf:record>
| + | |
| − | <cmdbf:instanceId>
| + | |
| − | <cmdbf:mdrId>org.eclipse.cosmos.samples.cmdbf.XMLRepository</cmdbf:mdrId>
| + | |
| − | <cmdbf:localId>staff01</cmdbf:localId>
| + | |
| − | </cmdbf:instanceId>
| + | |
| − | </cmdbf:item>
| + | |
| − | </cmdbf:nodes>
| + | |
| − | <cmdbf:nodes templateId="students">
| + | |
| − | <cmdbf:item>
| + | |
| − | <cmdbf:record xmlns="http://school">
| + | |
| − | | + | |
| − | <student>
| + | |
| − | <identity firstName="Mike" lastName="Lee" id="03"/>
| + | |
| − | </student>
| + | |
| − | | + | |
| − | <cmdbf:recordMetadata>
| + | |
| − | <cmdbf:recordId>03</cmdbf:recordId>
| + | |
| − | </cmdbf:recordMetadata>
| + | |
| − | </cmdbf:record>
| + | |
| − | <cmdbf:instanceId>
| + | |
| − | <cmdbf:mdrId>org.eclipse.cosmos.samples.cmdbf.XMLRepository</cmdbf:mdrId>
| + | |
| − | <cmdbf:localId>03</cmdbf:localId>
| + | |
| − | </cmdbf:instanceId>
| + | |
| − | </cmdbf:item>
| + | |
| − | <cmdbf:item>
| + | |
| − | <cmdbf:record xmlns="http://school">
| + | |
| − | | + | |
| − | <student>
| + | |
| − | <identity firstName="Bob" lastName="Davidson" id="01"/>
| + | |
| − | </student>
| + | |
| − | | + | |
| − | <cmdbf:recordMetadata>
| + | |
| − | <cmdbf:recordId>01</cmdbf:recordId>
| + | |
| − | </cmdbf:recordMetadata>
| + | |
| − | </cmdbf:record>
| + | |
| − | <cmdbf:instanceId>
| + | |
| − | <cmdbf:mdrId>org.eclipse.cosmos.samples.cmdbf.XMLRepository</cmdbf:mdrId>
| + | |
| − | <cmdbf:localId>01</cmdbf:localId>
| + | |
| − | </cmdbf:instanceId>
| + | |
| − | </cmdbf:item>
| + | |
| − | </cmdbf:nodes>
| + | |
| − | <cmdbf:edges templateId="reference">
| + | |
| − | <cmdbf:relationship>
| + | |
| − | <cmdbf:source>
| + | |
| − | <cmdbf:mdrId>org.eclipse.cosmos.samples.cmdbf.XMLRepository</cmdbf:mdrId>
| + | |
| − | <cmdbf:localId>staff01</cmdbf:localId>
| + | |
| − | </cmdbf:source>
| + | |
| − | <cmdbf:target>
| + | |
| − | <cmdbf:mdrId>org.eclipse.cosmos.samples.cmdbf.XMLRepository</cmdbf:mdrId>
| + | |
| − | <cmdbf:localId>03</cmdbf:localId>
| + | |
| − | </cmdbf:target>
| + | |
| − | <cmdbf:record xmlns="http://school">
| + | |
| − | | + | |
| − | <class name="Economics" courseCode="ECM01">
| + | |
| − | <students>
| + | |
| − | <enrolledStudent idRef="01"/>
| + | |
| − | <enrolledStudent idRef="03"/>
| + | |
| − | </students>
| + | |
| − | <teacher idRef="staff01"/>
| + | |
| − | </class>
| + | |
| − | | + | |
| − | <cmdbf:recordMetadata>
| + | |
| − | <cmdbf:recordId>ECM01</cmdbf:recordId>
| + | |
| − | </cmdbf:recordMetadata>
| + | |
| − | </cmdbf:record>
| + | |
| − | <cmdbf:instanceId>
| + | |
| − | <cmdbf:mdrId>org.eclipse.cosmos.samples.cmdbf.XMLRepository</cmdbf:mdrId>
| + | |
| − | <cmdbf:localId>ECM01</cmdbf:localId>
| + | |
| − | </cmdbf:instanceId>
| + | |
| − | </cmdbf:relationship>
| + | |
| − | <cmdbf:relationship>
| + | |
| − | <cmdbf:source>
| + | |
| − | <cmdbf:mdrId>org.eclipse.cosmos.samples.cmdbf.XMLRepository</cmdbf:mdrId>
| + | |
| − | <cmdbf:localId>staff01</cmdbf:localId>
| + | |
| − | </cmdbf:source>
| + | |
| − | <cmdbf:target>
| + | |
| − | <cmdbf:mdrId>org.eclipse.cosmos.samples.cmdbf.XMLRepository</cmdbf:mdrId>
| + | |
| − | <cmdbf:localId>01</cmdbf:localId>
| + | |
| − | </cmdbf:target>
| + | |
| − | <cmdbf:record xmlns="http://school">
| + | |
| − | | + | |
| − | <class name="Economics" courseCode="ECM01">
| + | |
| − | <students>
| + | |
| − | <enrolledStudent idRef="01"/>
| + | |
| − | <enrolledStudent idRef="03"/>
| + | |
| − | </students>
| + | |
| − | <teacher idRef="staff01"/>
| + | |
| − | </class>
| + | |
| − | | + | |
| − | <cmdbf:recordMetadata>
| + | |
| − | <cmdbf:recordId>ECM01</cmdbf:recordId>
| + | |
| − | </cmdbf:recordMetadata>
| + | |
| − | </cmdbf:record>
| + | |
| − | <cmdbf:instanceId>
| + | |
| − | <cmdbf:mdrId>org.eclipse.cosmos.samples.cmdbf.XMLRepository</cmdbf:mdrId>
| + | |
| − | <cmdbf:localId>ECM01</cmdbf:localId>
| + | |
| − | </cmdbf:instanceId>
| + | |
| − | </cmdbf:relationship>
| + | |
| − | </cmdbf:edges>
| + | |
| − | </cmdbf:queryResult>
| + | |
| − | | + | |
| − | </pre>
| + | |
| | | | |
| | [[Category:COSMOS_Development_Guide]] | | [[Category:COSMOS_Development_Guide]] |
