KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > xml > retriever > catalog > CatalogEntry


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-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */

19
20 package org.netbeans.modules.xml.retriever.catalog;
21
22 import java.util.HashMap JavaDoc;
23 import org.netbeans.modules.xml.xam.locator.*;
24
25 /**
26  *
27  * @author girix
28  */

29 public interface CatalogEntry {
30     
31     /**
32      * entryType - Catalog entry type as in public, system, rewriteSystem, etc.
33      **/

34     public CatalogElement getEntryType();
35     
36     /**
37      * one example of source is: systemId attribute value for system tag of catalog
38      **/

39     public String JavaDoc getSource();
40     /**
41      * one example of mappingEntity is: uri attribute value for system tag of catalog
42      */

43     public String JavaDoc getTarget();
44     
45     /**
46      * If catalog is augmented with extra attributes, then the key of the HashMap will
47      * be the attribute key and the value of the HashMap entry will be the value of the
48      * attribute
49      */

50     public HashMap JavaDoc<String JavaDoc,String JavaDoc> getExtraAttributeMap();
51     
52     
53     /**
54      * If this catalog entry is does not resolve to a file then valid=false
55      */

56     public boolean isValid();
57     
58 }
59
Popular Tags