KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > xml > schema > completion > util > CatalogModelProvider


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19 package org.netbeans.modules.xml.schema.completion.util;
20
21 import org.netbeans.modules.xml.xam.ModelSource;
22 import org.netbeans.modules.xml.xam.locator.CatalogModel;
23 import org.netbeans.modules.xml.xam.locator.CatalogModelException;
24 import org.openide.filesystems.FileObject;
25
26 /**
27  * We need to write unit tests for this module, however there is a
28  * challenge. This class is purely needed to solve that challenge.
29  *
30  * In order to get a model source or a model, we must first have a
31  * CatalogModel. In general you can get a CatalogModel from the
32  * CatalogModelFactory. But for unit tests, we need a special TestCatalogModel.
33  *
34  * In this module, we do not directly deal with CatalogModel and hence it is
35  * very difficult to use a TestCatalogModel from the unit tests.
36  *
37  * So the code uses lookup to find all CatalogModelProvider. If found uses it,
38  * else uses the real CatalogModel. The way it will work is, unit test code will
39  * create CatalogModelProvider which is going to return a TestCatalogModel.
40  *
41  * For all other use-cases, no CatalogModelProvider will be found and the module
42  * will use the project based CatalogModel.
43  *
44  * @see DefaultModelProvider#getCatalogModelProvider
45  *
46  * @author Samaresh
47  */
48 public abstract class CatalogModelProvider {
49     abstract CatalogModel getCatalogModel();
50     
51     abstract ModelSource getModelSource(FileObject fo, boolean editable)
52     throws CatalogModelException ;
53 }
54
Popular Tags