com.sun.xml.internal.stream.Entity Java Examples

/**
 * Adds an unparsed entity declaration.
 * <p>
 * <strong>Note:</strong> This method ignores subsequent entity
 * declarations.
 * <p>
 * <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 systemId The system identifier of the entity.
 * @param notation The name of the notation.
 *
 * @see SymbolTable
 */
public void addUnparsedEntity(String name,
        String publicId, String systemId,
        String baseSystemId, String notation) {
    if (!fEntities.containsKey(name)) {
        Entity.ExternalEntity entity = new Entity.ExternalEntity(name,
                new XMLEntityDescriptionImpl(name, publicId, systemId, baseSystemId, null),
                notation, fInExternalSubset);
        fEntities.put(name, entity);
    } else{
        if(fWarnDuplicateEntityDef){
            fErrorReporter.reportError(XMLMessageFormatter.XML_DOMAIN,
                    "MSG_DUPLICATE_ENTITY_DEFINITION",
                    new Object[]{ name },
                    XMLErrorReporter.SEVERITY_WARNING );
        }
    }
}
 

/**
 * Return the line number where the current document event ends.
 * <p>
 * <strong>Warning:</strong> The return value from the method
 * is intended only as an approximation for the sake of error
 * reporting; it is not intended to provide sufficient information
 * to edit the character content of the original XML document.
 * <p>
 * The return value is an approximation of the line number
 * in the document entity or external parsed entity where the
 * markup triggering the event appears.
 * <p>
 * If possible, the SAX driver should provide the line position
 * of the first character after the text associated with the document
 * event.  The first line in the document is line 1.
 *
 * @return The line number, or -1 if none is available.
 */
public int getLineNumber() {
    if (fCurrentEntity != null) {
        if (fCurrentEntity.isExternal()) {
            return fCurrentEntity.lineNumber;
        } else {
            // search for the first external entity on the stack
            int size = fEntityStack.size();
            for (int i=size-1; i>0 ; i--) {
                Entity.ScannedEntity firstExternalEntity = (Entity.ScannedEntity)fEntityStack.elementAt(i);
                if (firstExternalEntity.isExternal()) {
                    return firstExternalEntity.lineNumber;
                }
            }
        }
    }

    return -1;

}
 

/**
 * Adds an unparsed entity declaration.
 * <p>
 * <strong>Note:</strong> This method ignores subsequent entity
 * declarations.
 * <p>
 * <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 systemId The system identifier of the entity.
 * @param notation The name of the notation.
 *
 * @see SymbolTable
 */
public void addUnparsedEntity(String name,
        String publicId, String systemId,
        String baseSystemId, String notation) {
    if (!fEntities.containsKey(name)) {
        Entity.ExternalEntity entity = new Entity.ExternalEntity(name,
                new XMLEntityDescriptionImpl(name, publicId, systemId, baseSystemId, null),
                notation, fInExternalSubset);
        fEntities.put(name, entity);
    } else{
        if(fWarnDuplicateEntityDef){
            fErrorReporter.reportError(XMLMessageFormatter.XML_DOMAIN,
                    "MSG_DUPLICATE_ENTITY_DEFINITION",
                    new Object[]{ name },
                    XMLErrorReporter.SEVERITY_WARNING );
        }
    }
}
 

/**
 * Adds an unparsed entity declaration.
 * <p>
 * <strong>Note:</strong> This method ignores subsequent entity
 * declarations.
 * <p>
 * <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 systemId The system identifier of the entity.
 * @param notation The name of the notation.
 *
 * @see SymbolTable
 */
public void addUnparsedEntity(String name,
        String publicId, String systemId,
        String baseSystemId, String notation) {
    if (!fEntities.containsKey(name)) {
        Entity.ExternalEntity entity = new Entity.ExternalEntity(name,
                new XMLEntityDescriptionImpl(name, publicId, systemId, baseSystemId, null),
                notation, fInExternalSubset);
        fEntities.put(name, entity);
    } else{
        if(fWarnDuplicateEntityDef){
            fErrorReporter.reportError(XMLMessageFormatter.XML_DOMAIN,
                    "MSG_DUPLICATE_ENTITY_DEFINITION",
                    new Object[]{ name },
                    XMLErrorReporter.SEVERITY_WARNING );
        }
    }
}
 

/**
 * Return the expanded system identifier for the current document event.
 * <p>
 * The return value is the expanded system identifier of the document
 * entity or of the external parsed entity in which the markup
 * triggering the event appears.
 * <p>
 * If the system identifier is a URL, the parser must resolve it
 * fully before passing it to the application.
 *
 * @return A string containing the expanded system identifier, or null
 *         if none is available.
 */
public String getExpandedSystemId() {
    if (fCurrentEntity != null) {
        if (fCurrentEntity.entityLocation != null &&
                fCurrentEntity.entityLocation.getExpandedSystemId() != null ) {
            return fCurrentEntity.entityLocation.getExpandedSystemId();
        } else {
            // search for the first external entity on the stack
            int size = fEntityStack.size();
            for (int i = size - 1; i >= 0 ; i--) {
                Entity.ScannedEntity externalEntity =
                        (Entity.ScannedEntity)fEntityStack.elementAt(i);

                if (externalEntity.entityLocation != null &&
                        externalEntity.entityLocation.getExpandedSystemId() != null) {
                    return externalEntity.entityLocation.getExpandedSystemId();
                }
            }
        }
    }
    return null;
}
 

/**
 * Return the expanded system identifier for the current document event.
 * <p>
 * The return value is the expanded system identifier of the document
 * entity or of the external parsed entity in which the markup
 * triggering the event appears.
 * <p>
 * If the system identifier is a URL, the parser must resolve it
 * fully before passing it to the application.
 *
 * @return A string containing the expanded system identifier, or null
 *         if none is available.
 */
public String getExpandedSystemId() {
    if (fCurrentEntity != null) {
        if (fCurrentEntity.entityLocation != null &&
                fCurrentEntity.entityLocation.getExpandedSystemId() != null ) {
            return fCurrentEntity.entityLocation.getExpandedSystemId();
        } else {
            // search for the first external entity on the stack
            int size = fEntityStack.size();
            for (int i = size - 1; i >= 0 ; i--) {
                Entity.ScannedEntity externalEntity =
                        (Entity.ScannedEntity)fEntityStack.elementAt(i);

                if (externalEntity.entityLocation != null &&
                        externalEntity.entityLocation.getExpandedSystemId() != null) {
                    return externalEntity.entityLocation.getExpandedSystemId();
                }
            }
        }
    }
    return null;
}
 

/**
 * Return the line number where the current document event ends.
 * <p>
 * <strong>Warning:</strong> The return value from the method
 * is intended only as an approximation for the sake of error
 * reporting; it is not intended to provide sufficient information
 * to edit the character content of the original XML document.
 * <p>
 * The return value is an approximation of the line number
 * in the document entity or external parsed entity where the
 * markup triggering the event appears.
 * <p>
 * If possible, the SAX driver should provide the line position
 * of the first character after the text associated with the document
 * event.  The first line in the document is line 1.
 *
 * @return The line number, or -1 if none is available.
 */
public int getLineNumber() {
    if (fCurrentEntity != null) {
        if (fCurrentEntity.isExternal()) {
            return fCurrentEntity.lineNumber;
        } else {
            // search for the first external entity on the stack
            int size = fEntityStack.size();
            for (int i=size-1; i>0 ; i--) {
                Entity.ScannedEntity firstExternalEntity = (Entity.ScannedEntity)fEntityStack.elementAt(i);
                if (firstExternalEntity.isExternal()) {
                    return firstExternalEntity.lineNumber;
                }
            }
        }
    }

    return -1;

}
 

/**
 * Return the expanded system identifier for the current document event.
 * <p>
 * The return value is the expanded system identifier of the document
 * entity or of the external parsed entity in which the markup
 * triggering the event appears.
 * <p>
 * If the system identifier is a URL, the parser must resolve it
 * fully before passing it to the application.
 *
 * @return A string containing the expanded system identifier, or null
 *         if none is available.
 */
public String getExpandedSystemId() {
    if (fCurrentEntity != null) {
        if (fCurrentEntity.entityLocation != null &&
                fCurrentEntity.entityLocation.getExpandedSystemId() != null ) {
            return fCurrentEntity.entityLocation.getExpandedSystemId();
        } else {
            // search for the first external entity on the stack
            int size = fEntityStack.size();
            for (int i = size - 1; i >= 0 ; i--) {
                Entity.ScannedEntity externalEntity =
                        (Entity.ScannedEntity)fEntityStack.elementAt(i);

                if (externalEntity.entityLocation != null &&
                        externalEntity.entityLocation.getExpandedSystemId() != null) {
                    return externalEntity.entityLocation.getExpandedSystemId();
                }
            }
        }
    }
    return null;
}
 

/** set the instance of current scanned entity.
 *   @param ScannedEntity
 */

public final void setCurrentEntity(Entity.ScannedEntity scannedEntity){
    fCurrentEntity = scannedEntity ;
    if(fCurrentEntity != null){
        isExternal = fCurrentEntity.isExternal();
        if(DEBUG_BUFFER)
            System.out.println("Current Entity is "+scannedEntity.name);
    }
}
 

/** set the instance of current scanned entity.
 *   @param ScannedEntity
 */

public final void setCurrentEntity(Entity.ScannedEntity scannedEntity){
    fCurrentEntity = scannedEntity ;
    if(fCurrentEntity != null){
        isExternal = fCurrentEntity.isExternal();
        if(DEBUG_BUFFER)
            System.out.println("Current Entity is "+scannedEntity.name);
    }
}
 

/**
 * Adds an external entity declaration.
 * <p>
 * <strong>Note:</strong> This method ignores subsequent entity
 * declarations.
 * <p>
 * <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
 *                     is used to expand the system identifier when
 *                     the system identifier is a relative URI.
 *                     When null the system identifier of the first
 *                     external entity on the stack is used instead.
 *
 * @see SymbolTable
 */
public void addExternalEntity(String name,
        String publicId, String literalSystemId,
        String baseSystemId) throws IOException {
    if (!fEntities.containsKey(name)) {
        if (baseSystemId == null) {
            // search for the first external entity on the stack
            int size = fEntityStack.size();
            if (size == 0 && fCurrentEntity != null && fCurrentEntity.entityLocation != null) {
                baseSystemId = fCurrentEntity.entityLocation.getExpandedSystemId();
            }
            for (int i = size - 1; i >= 0 ; i--) {
                Entity.ScannedEntity externalEntity =
                        (Entity.ScannedEntity)fEntityStack.elementAt(i);
                if (externalEntity.entityLocation != null && externalEntity.entityLocation.getExpandedSystemId() != null) {
                    baseSystemId = externalEntity.entityLocation.getExpandedSystemId();
                    break;
                }
            }
        }
        Entity entity = new Entity.ExternalEntity(name,
                new XMLEntityDescriptionImpl(name, publicId, literalSystemId, baseSystemId,
                expandSystemId(literalSystemId, baseSystemId, false)), null, fInExternalSubset);
        fEntities.put(name, entity);
    } else{
        if(fWarnDuplicateEntityDef){
            fErrorReporter.reportError(XMLMessageFormatter.XML_DOMAIN,
                    "MSG_DUPLICATE_ENTITY_DEFINITION",
                    new Object[]{ name },
                    XMLErrorReporter.SEVERITY_WARNING );
        }
    }

}
 

public XMLStringBuffer getDTDDecl(){
    Entity entity = fEntityScanner.getCurrentEntity();
    fDTDDecl.append(((Entity.ScannedEntity)entity).ch,fStartPos , fEndPos-fStartPos);
    if(fSeenInternalSubset)
        fDTDDecl.append("]>");
    return fDTDDecl;
}
 

public XMLStringBuffer getDTDDecl(){
    Entity entity = fEntityScanner.getCurrentEntity();
    fDTDDecl.append(((Entity.ScannedEntity)entity).ch,fStartPos , fEndPos-fStartPos);
    if(fSeenInternalSubset)
        fDTDDecl.append("]>");
    return fDTDDecl;
}
 

/**
 * Checks whether an entity given by name is external.
 *
 * @param entityName The name of the entity to check.
 * @return True if the entity is external, false otherwise
 * (including when the entity is not declared).
 */
public boolean isExternalEntity(String entityName) {

    Entity entity = fEntities.get(entityName);
    if (entity == null) {
        return false;
    }
    return entity.isExternal();
}
 

public XMLStringBuffer getDTDDecl(){
    Entity entity = fEntityScanner.getCurrentEntity();
    fDTDDecl.append(((Entity.ScannedEntity)entity).ch,fStartPos , fEndPos-fStartPos);
    if(fSeenInternalSubset)
        fDTDDecl.append("]>");
    return fDTDDecl;
}
 

public int read(byte[] b, int off, int len) throws IOException {
    final int bytesLeft = fLength - fOffset;
    if (bytesLeft == 0) {
        if (fOffset == fEndOffset) {
            return -1;
        }

        // read a block of data as requested
        if(fCurrentEntity.mayReadChunks || !fCurrentEntity.xmlDeclChunkRead) {

            if (!fCurrentEntity.xmlDeclChunkRead)
            {
                fCurrentEntity.xmlDeclChunkRead = true;
                len = Entity.ScannedEntity.DEFAULT_XMLDECL_BUFFER_SIZE;
            }
            return fInputStream.read(b, off, len);
        }
        int returnedVal = readAndBuffer();
        if (returnedVal == -1) {
            fEndOffset = fOffset;
            return -1;
        }
        b[off] = (byte)returnedVal;
        return 1;
    }
    if (len < bytesLeft) {
        if (len <= 0) {
            return 0;
        }
    } else {
        len = bytesLeft;
    }
    if (b != null) {
        System.arraycopy(fData, fOffset, b, off, len);
    }
    fOffset += len;
    return len;
}
 

/** set the instance of current scanned entity.
 *   @param ScannedEntity
 */

public final void setCurrentEntity(Entity.ScannedEntity scannedEntity){
    fCurrentEntity = scannedEntity ;
    if(fCurrentEntity != null){
        isExternal = fCurrentEntity.isExternal();
        if(DEBUG_BUFFER)
            System.out.println("Current Entity is "+scannedEntity.name);
    }
}
 

/**
 * Checks whether an entity given by name is external.
 *
 * @param entityName The name of the entity to check.
 * @return True if the entity is external, false otherwise
 * (including when the entity is not declared).
 */
public boolean isExternalEntity(String entityName) {

    Entity entity = (Entity)fEntities.get(entityName);
    if (entity == null) {
        return false;
    }
    return entity.isExternal();
}
 

public boolean isUnparsedEntity(String entityName) {

        Entity entity = (Entity)fEntities.get(entityName);
        if (entity == null) {
            return false;
        }
        return entity.isUnparsed();
    }
 

public boolean isUnparsedEntity(String entityName) {

        Entity entity = fEntities.get(entityName);
        if (entity == null) {
            return false;
        }
        return entity.isUnparsed();
    }
 

public XMLStringBuffer getDTDDecl(){
    Entity entity = fEntityScanner.getCurrentEntity();
    fDTDDecl.append(((Entity.ScannedEntity)entity).ch,fStartPos , fEndPos-fStartPos);
    if(fSeenInternalSubset)
        fDTDDecl.append("]>");
    return fDTDDecl;
}
 

/**
 * Checks whether the declaration of an entity given by name is
 * // in the external subset.
 *
 * @param entityName The name of the entity to check.
 * @return True if the entity was declared in the external subset, false otherwise
 *           (including when the entity is not declared).
 */
public boolean isEntityDeclInExternalSubset(String entityName) {

    Entity entity = fEntities.get(entityName);
    if (entity == null) {
        return false;
    }
    return entity.isEntityDeclInExternalSubset();
}
 

public boolean isUnparsedEntity(String entityName) {

        Entity entity = fEntities.get(entityName);
        if (entity == null) {
            return false;
        }
        return entity.isUnparsed();
    }
 

/** set the instance of current scanned entity.
 *   @param ScannedEntity
 */

public final void setCurrentEntity(Entity.ScannedEntity scannedEntity){
    fCurrentEntity = scannedEntity ;
    if(fCurrentEntity != null){
        isExternal = fCurrentEntity.isExternal();
        if(DEBUG_BUFFER)
            System.out.println("Current Entity is "+scannedEntity.name);
    }
}
 

public XMLStringBuffer getDTDDecl(){
    Entity entity = fEntityScanner.getCurrentEntity();
    fDTDDecl.append(((Entity.ScannedEntity)entity).ch,fStartPos , fEndPos-fStartPos);
    if(fSeenInternalSubset)
        fDTDDecl.append("]>");
    return fDTDDecl;
}
 

/**
 * Checks whether the declaration of an entity given by name is
 * // in the external subset.
 *
 * @param entityName The name of the entity to check.
 * @return True if the entity was declared in the external subset, false otherwise
 *           (including when the entity is not declared).
 */
public boolean isEntityDeclInExternalSubset(String entityName) {

    Entity entity = fEntities.get(entityName);
    if (entity == null) {
        return false;
    }
    return entity.isEntityDeclInExternalSubset();
}
 

/**
 * Adds an external entity declaration.
 * <p>
 * <strong>Note:</strong> This method ignores subsequent entity
 * declarations.
 * <p>
 * <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
 *                     is used to expand the system identifier when
 *                     the system identifier is a relative URI.
 *                     When null the system identifier of the first
 *                     external entity on the stack is used instead.
 *
 * @see SymbolTable
 */
public void addExternalEntity(String name,
        String publicId, String literalSystemId,
        String baseSystemId) throws IOException {
    if (!fEntities.containsKey(name)) {
        if (baseSystemId == null) {
            // search for the first external entity on the stack
            int size = fEntityStack.size();
            if (size == 0 && fCurrentEntity != null && fCurrentEntity.entityLocation != null) {
                baseSystemId = fCurrentEntity.entityLocation.getExpandedSystemId();
            }
            for (int i = size - 1; i >= 0 ; i--) {
                Entity.ScannedEntity externalEntity =
                        (Entity.ScannedEntity)fEntityStack.elementAt(i);
                if (externalEntity.entityLocation != null && externalEntity.entityLocation.getExpandedSystemId() != null) {
                    baseSystemId = externalEntity.entityLocation.getExpandedSystemId();
                    break;
                }
            }
        }
        Entity entity = new Entity.ExternalEntity(name,
                new XMLEntityDescriptionImpl(name, publicId, literalSystemId, baseSystemId,
                expandSystemId(literalSystemId, baseSystemId, false)), null, fInExternalSubset);
        fEntities.put(name, entity);
    } else{
        if(fWarnDuplicateEntityDef){
            fErrorReporter.reportError(XMLMessageFormatter.XML_DOMAIN,
                    "MSG_DUPLICATE_ENTITY_DEFINITION",
                    new Object[]{ name },
                    XMLErrorReporter.SEVERITY_WARNING );
        }
    }

}
 

public XMLStringBuffer getDTDDecl(){
    Entity entity = fEntityScanner.getCurrentEntity();
    fDTDDecl.append(((Entity.ScannedEntity)entity).ch,fStartPos , fEndPos-fStartPos);
    if(fSeenInternalSubset)
        fDTDDecl.append("]>");
    return fDTDDecl;
}
 

/**
 * Adds an external entity declaration.
 * <p>
 * <strong>Note:</strong> This method ignores subsequent entity
 * declarations.
 * <p>
 * <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
 *                     is used to expand the system identifier when
 *                     the system identifier is a relative URI.
 *                     When null the system identifier of the first
 *                     external entity on the stack is used instead.
 *
 * @see SymbolTable
 */
public void addExternalEntity(String name,
        String publicId, String literalSystemId,
        String baseSystemId) throws IOException {
    if (!fEntities.containsKey(name)) {
        if (baseSystemId == null) {
            // search for the first external entity on the stack
            int size = fEntityStack.size();
            if (size == 0 && fCurrentEntity != null && fCurrentEntity.entityLocation != null) {
                baseSystemId = fCurrentEntity.entityLocation.getExpandedSystemId();
            }
            for (int i = size - 1; i >= 0 ; i--) {
                Entity.ScannedEntity externalEntity =
                        (Entity.ScannedEntity)fEntityStack.elementAt(i);
                if (externalEntity.entityLocation != null && externalEntity.entityLocation.getExpandedSystemId() != null) {
                    baseSystemId = externalEntity.entityLocation.getExpandedSystemId();
                    break;
                }
            }
        }
        Entity entity = new Entity.ExternalEntity(name,
                new XMLEntityDescriptionImpl(name, publicId, literalSystemId, baseSystemId,
                expandSystemId(literalSystemId, baseSystemId, false)), null, fInExternalSubset);
        fEntities.put(name, entity);
    } else{
        if(fWarnDuplicateEntityDef){
            fErrorReporter.reportError(XMLMessageFormatter.XML_DOMAIN,
                    "MSG_DUPLICATE_ENTITY_DEFINITION",
                    new Object[]{ name },
                    XMLErrorReporter.SEVERITY_WARNING );
        }
    }

}
 

/** set the instance of current scanned entity.
 *   @param ScannedEntity
 */

public final void setCurrentEntity(Entity.ScannedEntity scannedEntity){
    fCurrentEntity = scannedEntity ;
    if(fCurrentEntity != null){
        isExternal = fCurrentEntity.isExternal();
        if(DEBUG_BUFFER)
            System.out.println("Current Entity is "+scannedEntity.name);
    }
}