Skip to content

[XERCESJ-70] Clarify meaning of the term baseSystemID #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
elharo merged 6 commits into from
Jan 22, 2026
Merged

[XERCESJ-70] Clarify meaning of the term baseSystemID #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
88cc019
correct Javadoc
elharo Jul 4, 2025
f1f2c46
Clarify meaning of the term baseSystemID
elharo Jul 4, 2025
e34dd1f
more edits
elharo Jul 4, 2025
d3fddf7
remove
elharo Jul 4, 2025
d9f4ca6
merge
elharo Jan 21, 2026
d43383f
merge main
elharo Jan 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/xni-core.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -496,7 +496,7 @@
which this object relates to.
</li>
<li> expandedSystemId: The value of the systemId (or
<code>schemaLocation</code>) after being subjects to relative
<code>schemaLocation</code>) after relative
URI expansion. SAX programmers will be familiar with this
concept from the SAX Locator interface, for example; this
property maps to the <code>systemId</code> property of that
Expand All @@ -521,7 +521,7 @@
This interface is used to communicate the document location to
the various handler interfaces. The application can use the
methods on this interface to query the public, literal system, and expanded system
base system identifier as well as the line number, column number
identifier as well as the line number, column number
and the encoding of the entity currently being parsed.
</p>
<p>
Expand Down
12 changes: 3 additions & 9 deletions samples/xni/PSVIWriter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,19 +315,13 @@ public XMLDocumentSource getDocumentSource() {
* <strong>Note:</strong> This method is not called for entity references
* appearing as part of attribute values.
*
* @param name The name of the entity.
* @param publicId The public identifier of the entity if the entity
* is external, null otherwise.
* @param systemId The system identifier of the entity if the entity
* is external, null otherwise.
* @param baseSystemId The base system identifier of the entity if
* the entity is external, null otherwise.
* @param encoding The auto-detected IANA encoding name of the entity
* @param name the name of the entity
* @param encoding the auto-detected IANA encoding name of the entity
* stream. This value will be null in those situations
* where the entity encoding is not auto-detected (e.g.
* internal entities or a document entity that is
* parsed from a java.io.Reader).
* @param augs Additional information that may include infoset augmentations
* @param augs additional information that may include infoset augmentations
*
* @throws XNIException Thrown by handler to signal an error.
*/
Expand Down
10 changes: 2 additions & 8 deletions samples/xni/PassThroughFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,14 +220,8 @@ public void endElement(QName element, Augmentations augs)
* <strong>Note:</strong> This method is not called for entity references
* appearing as part of attribute values.
*
* @param name The name of the entity.
* @param publicId The public identifier of the entity if the entity
* is external, null otherwise.
* @param systemId The system identifier of the entity if the entity
* is external, null otherwise.
* @param baseSystemId The base system identifier of the entity if
* the entity is external, null otherwise.
* @param encoding The auto-detected IANA encoding name of the entity
* @param name the name of the entity.
* @param encoding the auto-detected IANA encoding name of the entity
* stream. This value will be null in those situations
* where the entity encoding is not auto-detected (e.g.
* internal entities or a document entity that is
Expand Down
56 changes: 23 additions & 33 deletions src/org/apache/xerces/dom/DOMInputImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,15 +92,15 @@ public DOMInputImpl() {}
* identifiers, leaving resolution of the entity and opening of
* the input stream up to the caller.
*
* @param publicId The public identifier, if known.
* @param systemId The system identifier. This value should
* @param publicId the public identifier, if known
* @param systemId the system identifier. This value should
* always be set, if possible, and can be
* relative or absolute. If the system identifier
* is relative, then the base system identifier
* should be set.
* @param baseSystemId The base system identifier. This value should
* always be set to the fully expanded URI of the
* base system identifier, if possible.
* @param baseSystemId the base system identifier. This value should
* always be set to the expanded absolute URI of the
* system identifier, if possible.
*/

public DOMInputImpl(String publicId, String systemId,
Expand All @@ -115,17 +115,15 @@ public DOMInputImpl(String publicId, String systemId,
/**
* Constructs an input source from a byte stream.
*
* @param publicId The public identifier, if known.
* @param systemId The system identifier. This value should
* @param publicId the public identifier, if known
* @param systemId the system identifier. This value should
* always be set, if possible, and can be
* relative or absolute. If the system identifier
* is relative, then the base system identifier
* should be set.
* @param baseSystemId The base system identifier. This value should
* always be set to the fully expanded URI of the
* base system identifier, if possible.
* @param byteStream The byte stream.
* @param encoding The encoding of the byte stream, if known.
* @param baseSystemId the base system identifier against which the system identifier should be resolved
* @param byteStream the byte stream
* @param encoding the encoding of the byte stream, if known
*/

public DOMInputImpl(String publicId, String systemId,
Expand All @@ -143,18 +141,16 @@ public DOMInputImpl(String publicId, String systemId,
/**
* Constructs an input source from a character stream.
*
* @param publicId The public identifier, if known.
* @param systemId The system identifier. This value should
* @param publicId the public identifier, if knownt
* @param systemId the system identifier. This value should
* always be set, if possible, and can be
* relative or absolute. If the system identifier
* is relative, then the base system identifier
* should be set.
* @param baseSystemId The base system identifier. This value should
* always be set to the fully expanded URI of the
* base system identifier, if possible.
* @param charStream The character stream.
* @param encoding The original encoding of the byte stream
* used by the reader, if known.
* @param baseSystemId the base system identifier against which the system identifier should be resolved
* @param charStream the character stream
* @param encoding the original encoding of the byte stream
* used by the reader, if known
*/

public DOMInputImpl(String publicId, String systemId,
Expand All @@ -172,20 +168,14 @@ public DOMInputImpl(String publicId, String systemId,
/**
* Constructs an input source from a String.
*
* @param publicId The public identifier, if known.
* @param systemId The system identifier. This value should
* always be set, if possible, and can be
* relative or absolute. If the system identifier
* is relative, then the base system identifier
* should be set.
* @param baseSystemId The base system identifier. This value should
* always be set to the fully expanded URI of the
* base system identifier, if possible.
* @param data The String Data.
* @param encoding The original encoding of the byte stream
* used by the reader, if known.
* @param publicId the public identifier, if known
* @param systemId the system identifier. This value should always be set, if possible, and can be
* relative or absolute. If the system identifier is relative, then the base system identifier
* should be set.
* @param baseSystemId the base system identifier against which the system identifier should be resolved
* @param data the String data
* @param encoding the original encoding of the byte stream used by the reader, if known
*/

public DOMInputImpl(String publicId, String systemId,
String baseSystemId, String data,
String encoding) {
Expand Down
11 changes: 5 additions & 6 deletions src/org/apache/xerces/impl/XMLEntityManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -543,12 +543,11 @@ public int getParamEntityRefCount(String entityName) {
* <strong>Note:</strong> The name should be a unique symbol. The
* SymbolTable can be used for this purpose.
*
* @param name The name of the entity.
* @param publicId The public identifier of the entity.
* @param literalSystemId The system identifier of the entity.
* @param baseSystemId The base system identifier of the entity.
* This is the system identifier of the entity
* where <em>the entity being added</em> and
* @param name the name of the entity
* @param publicId the public identifier of the entity
* @param literalSystemId the system identifier of the entity
* @param baseSystemId the base URL of the entity. This is the URL of the entity
* where <em>the entity is being added</em> and
* is used to expand the system identifier when
* the system identifier is a relative URI.
* When null the system identifier of the first
Expand Down
2 changes: 1 addition & 1 deletion src/org/apache/xerces/impl/XMLEntityScanner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ public XMLEntityScanner() {
//

/**
* Returns the base system identifier of the currently scanned
* Returns the base URL of the currently scanned
* entity, or null if none is available.
*/
public final String getBaseSystemId() {
Expand Down
8 changes: 3 additions & 5 deletions src/org/apache/xerces/impl/dtd/DTDGrammar.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,12 +365,10 @@ public int getAttributeDeclIndex(int elementDeclIndex, String attributeDeclName)
* location cannot be reported during the parsing of
* the document DTD. However, it is <em>strongly</em>
* recommended that a locator be supplied that can
* at least report the base system identifier of the
* DTD.
* at least report the base URI of the DTD.
*
* @param augs Additional information that may include infoset
* augmentations.
* @throws XNIException Thrown by handler to signal an error.
* @param augs additional information that may include infoset augmentations
* @throws XNIException thrown by handler to signal an error
*/
public void startDTD(XMLLocator locator, Augmentations augs) throws XNIException {
//Initialize stack
Expand Down
10 changes: 4 additions & 6 deletions src/org/apache/xerces/impl/dtd/XMLDTDProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -619,16 +619,14 @@ public void processingInstruction(String target, XMLString data, Augmentations a
/**
* The start of the DTD.
*
* @param locator The document locator, or null if the document
* @param locator the document locator, or null if the document
* location cannot be reported during the parsing of
* the document DTD. However, it is <em>strongly</em>
* recommended that a locator be supplied that can
* at least report the base system identifier of the
* DTD.
* @param augs Additional information that may include infoset
* augmentations.
* at least report the base URI of the DTD.
* @param augs additional information that may include infoset augmentations
*
* @throws XNIException Thrown by handler to signal an error.
* @throws XNIException thrown by handler to signal an error
*/
public void startDTD(XMLLocator locator, Augmentations augs) throws XNIException {

Expand Down
14 changes: 6 additions & 8 deletions src/org/apache/xerces/impl/xs/opti/DefaultXMLDocumentHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,16 +342,14 @@ public void endDocument(Augmentations augs) throws XNIException {
/**
* The start of the DTD.
*
* @param locator The document locator, or null if the document
* location cannot be reported during the parsing of
* @param locator the document locator, or null if the document
* location cannot be reported during the parsing of
* the document DTD. However, it is <em>strongly</em>
* recommended that a locator be supplied that can
* at least report the base system identifier of the
* DTD.
* @param augmentations Additional information that may include infoset
* augmentations.
* recommended that a locator be supplied that can
* at least report the base URI of the DTD.
* @param augmentations additional information that may include infoset augmentations
*
* @throws XNIException Thrown by handler to signal an error.
* @throws XNIException thrown by handler to signal an error
*/
public void startDTD(XMLLocator locator, Augmentations augmentations)
throws XNIException {
Expand Down
9 changes: 5 additions & 4 deletions src/org/apache/xerces/parsers/AbstractDOMParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1801,10 +1801,11 @@ else if (nodeType == Node.PROCESSING_INSTRUCTION_NODE) {
/**
* The start of the DTD.
*
* @param locator the document locator, or null if the document location cannot be
* reported during the parsing of the document DTD. However, it is
* <em>strongly</em> recommended that a locator be supplied that can
* at least report the base system identifier of the DTD.
* @param locator the document locator, or null if the document
* location cannot be reported during the parsing of
* the document DTD. However, it is <em>strongly</em>
* recommended that a locator be supplied that can
* at least report the base URI of the DTD.
* @param augs additional information that may include infoset augmentations
*
* @throws XNIException thrown by handler to signal an error
Expand Down
9 changes: 5 additions & 4 deletions src/org/apache/xerces/parsers/AbstractXMLDocumentParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -364,10 +364,11 @@ public XMLDocumentSource getDocumentSource (){
/**
* The start of the DTD.
*
* @param locator the document locator, or null if the document location cannot be
* reported during the parsing of the document DTD. However, it is
* <em>strongly</em> recommended that a locator be supplied that can
* at least report the base system identifier of the DTD.
* @param locator the document locator, or null if the document
* location cannot be reported during the parsing of
* the document DTD. However, it is <em>strongly</em>
* recommended that a locator be supplied that can
* at least report the base URI of the DTD.
* @param augs additional information that may include infoset augmentations
*
* @throws XNIException thrown by handler to signal an error
Expand Down
39 changes: 18 additions & 21 deletions src/org/apache/xerces/util/HTTPInputSource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,15 +59,14 @@ public final class HTTPInputSource extends XMLInputSource {
* identifiers, leaving resolution of the entity and opening of
* the input stream up to the caller.
*
* @param publicId The public identifier, if known.
* @param systemId The system identifier. This value should
* @param publicId the public identifier, if known
* @param systemId the system identifier. This value should
* always be set, if possible, and can be
* relative or absolute. If the system identifier
* is relative, then the base system identifier
* should be set.
* @param baseSystemId The base system identifier. This value should
* always be set to the fully expanded URI of the
* base system identifier, if possible.
* should also be set.
* @param baseSystemId the base system identifier. This value should
* always be an absolute base URI applicable to the system identifier.
*/
public HTTPInputSource(String publicId, String systemId, String baseSystemId) {
super(publicId, systemId, baseSystemId);
Expand All @@ -87,15 +86,14 @@ public HTTPInputSource(XMLResourceIdentifier resourceIdentifier) {
/**
* Constructs an input source from a byte stream.
*
* @param publicId The public identifier, if known.
* @param systemId The system identifier. This value should
* @param publicId the public identifier, if known
* @param systemId the system identifier. This value should
* always be set, if possible, and can be
* relative or absolute. If the system identifier
* is relative, then the base system identifier
* should be set.
* @param baseSystemId The base system identifier. This value should
* always be set to the fully expanded URI of the
* base system identifier, if possible.
* should also be set.
* @param baseSystemId the base system identifier. This value should
* always be an absolute base URI applicable to the system identifier.
* @param byteStream The byte stream.
* @param encoding The encoding of the byte stream, if known.
*/
Expand All @@ -107,18 +105,17 @@ public HTTPInputSource(String publicId, String systemId,
/**
* Constructs an input source from a character stream.
*
* @param publicId The public identifier, if known.
* @param systemId The system identifier. This value should
* @param publicId the public identifier, if known
* @param systemId the system identifier. This value should
* always be set, if possible, and can be
* relative or absolute. If the system identifier
* is relative, then the base system identifier
* should be set.
* @param baseSystemId The base system identifier. This value should
* always be set to the fully expanded URI of the
* base system identifier, if possible.
* @param charStream The character stream.
* @param encoding The original encoding of the byte stream
* used by the reader, if known.
* should also be set.
* @param baseSystemId the base system identifier. This value should
* always be an absolute base URI applicable to the system identifier.
* @param charStream the character stream
* @param encoding the original encoding of the byte stream
* used by the reader, if known
*/
public HTTPInputSource(String publicId, String systemId,
String baseSystemId, Reader charStream, String encoding) {
Expand Down
Loading