KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > xerces > dom3 > as > ASEntityDeclaration


1 /*
2  * Copyright (c) 2001 World Wide Web Consortium,
3  * (Massachusetts Institute of Technology, Institut National de
4  * Recherche en Informatique et en Automatique, Keio University). All
5  * Rights Reserved. This program is distributed under the W3C's Software
6  * Intellectual Property License. This program is distributed in the
7  * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
8  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
9  * PURPOSE.
10  * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
11  */

12
13 package org.apache.xerces.dom3.as;
14
15 /**
16  * @deprecated
17  * Models a general entity declaration in an abstract schema. The abstract
18  * schema does not handle any parameter entity. It is assumed that the
19  * parameter entities are expanded by the implementation as the abstract
20  * schema is built.
21  * <p>See also the <a HREF='http://www.w3.org/TR/2001/WD-DOM-Level-3-ASLS-20011025'>Document Object Model (DOM) Level 3 Abstract Schemas and Load
22 and Save Specification</a>.
23  */

24 public interface ASEntityDeclaration extends ASObject {
25     // EntityType
26
/**
27      * constant defining an internal entity.
28      */

29     public static final short INTERNAL_ENTITY = 1;
30     /**
31      * constant defining an external entity.
32      */

33     public static final short EXTERNAL_ENTITY = 2;
34
35     /**
36      * The type of the entity as defined above.
37      */

38     public short getEntityType();
39     /**
40      * The type of the entity as defined above.
41      */

42     public void setEntityType(short entityType);
43
44     /**
45      * The replacement text for the internal entity. The entity references
46      * within the replacement text are kept intact. For an entity of type
47      * <code>EXTERNAL_ENTITY</code>, this is <code>null</code>.
48      */

49     public String JavaDoc getEntityValue();
50     /**
51      * The replacement text for the internal entity. The entity references
52      * within the replacement text are kept intact. For an entity of type
53      * <code>EXTERNAL_ENTITY</code>, this is <code>null</code>.
54      */

55     public void setEntityValue(String JavaDoc entityValue);
56
57     /**
58      * the URI reference representing the system identifier for the notation
59      * declaration, if present, <code>null</code> otherwise.
60      */

61     public String JavaDoc getSystemId();
62     /**
63      * the URI reference representing the system identifier for the notation
64      * declaration, if present, <code>null</code> otherwise.
65      */

66     public void setSystemId(String JavaDoc systemId);
67
68     /**
69      * The string representing the public identifier for this notation
70      * declaration, if present; <code>null</code> otherwise.
71      */

72     public String JavaDoc getPublicId();
73     /**
74      * The string representing the public identifier for this notation
75      * declaration, if present; <code>null</code> otherwise.
76      */

77     public void setPublicId(String JavaDoc publicId);
78
79 }
80
Popular Tags