Author: rhauch Date: 2008-06-10 17:50:33 -0400 (Tue, 10 Jun 2008) New Revision: 256 Modified: trunk/dna-repository/src/main/java/org/jboss/dna/repository/sequencers/xml/XmlSequencer.java Log: Removed unused exceptions in signatures. Modified: trunk/dna-repository/src/main/java/org/jboss/dna/repository/sequencers/xml/XmlSequencer.java =================================================================== --- trunk/dna-repository/src/main/java/org/jboss/dna/repository/sequencers/xml/XmlSequencer.java 2008-06-10 21:15:46 UTC (rev 255) +++ trunk/dna-repository/src/main/java/org/jboss/dna/repository/sequencers/xml/XmlSequencer.java 2008-06-10 21:50:33 UTC (rev 256) @@ -33,649 +33,649 @@ */ public class XmlSequencer implements StreamSequencer { - static final Logger LOGGER = Logger.getLogger(XmlSequencer.class); + static final Logger LOGGER = Logger.getLogger(XmlSequencer.class); - static final String CDATA = "dnaxml:cData"; - static final String CDATA_CONTENT = "dnaxml:cDataContent"; - static final String COMMENT = "dnaxml:comment"; - static final String COMMENT_CONTENT = "dnaxml:commentContent"; - static final String DOCUMENT = "dnaxml:document"; - static final String DTD_NAME = "dnadtd:name"; - static final String DTD_PUBLIC_ID = "dnadtd:publicId"; - static final String DTD_SYSTEM_ID = "dnadtd:systemId"; - static final String DTD_VALUE = "dnadtd:value"; - static final String ELEMENT_CONTENT = "dnaxml:elementContent"; - static final String ENTITY = "dnadtd:entity"; - static final String PI = "dnaxml:processingInstruction"; - static final String PI_CONTENT = "dnaxml:processingInstructionContent"; - static final String TARGET = "dnaxml:target"; + static final String CDATA = "dnaxml:cData"; + static final String CDATA_CONTENT = "dnaxml:cDataContent"; + static final String COMMENT = "dnaxml:comment"; + static final String COMMENT_CONTENT = "dnaxml:commentContent"; + static final String DOCUMENT = "dnaxml:document"; + static final String DTD_NAME = "dnadtd:name"; + static final String DTD_PUBLIC_ID = "dnadtd:publicId"; + static final String DTD_SYSTEM_ID = "dnadtd:systemId"; + static final String DTD_VALUE = "dnadtd:value"; + static final String ELEMENT_CONTENT = "dnaxml:elementContent"; + static final String ENTITY = "dnadtd:entity"; + static final String PI = "dnaxml:processingInstruction"; + static final String PI_CONTENT = "dnaxml:processingInstructionContent"; + static final String TARGET = "dnaxml:target"; - private static final String DECL_HANDLER_FEATURE = "http://xml.org/sax/properties/declaration-handler"; - private static final String ENTITY_RESOLVER_2_FEATURE = "http://xml.org/sax/features/use-entity-resolver2"; - private static final String LEXICAL_HANDLER_FEATURE = "http://xml.org/sax/properties/lexical-handler"; + private static final String DECL_HANDLER_FEATURE = "http://xml.org/sax/properties/declaration-handler"; + private static final String ENTITY_RESOLVER_2_FEATURE = "http://xml.org/sax/features/use-entity-resolver2"; + private static final String LEXICAL_HANDLER_FEATURE = "http://xml.org/sax/properties/lexical-handler"; - /** - * <p> - * {@inheritDoc} - * </p> - * - * @see org.jboss.dna.spi.sequencers.StreamSequencer#sequence(java.io.InputStream, - * org.jboss.dna.spi.sequencers.SequencerOutput, org.jboss.dna.common.monitor.ProgressMonitor) - */ - public void sequence( InputStream stream, - SequencerOutput output, - ProgressMonitor monitor ) { - monitor.beginTask(100.0, RepositoryI18n.sequencingXmlDocument); - XMLReader reader; - try { - reader = XMLReaderFactory.createXMLReader(); - Handler handler = new Handler(output, monitor); - reader.setContentHandler(handler); - reader.setErrorHandler(handler); - // Ensure handler acting as entity resolver 2 - reader.setProperty(DECL_HANDLER_FEATURE, handler); - // Ensure handler acting as lexical handler - reader.setProperty(LEXICAL_HANDLER_FEATURE, handler); - // Ensure handler acting as entity resolver 2 - try { - if (!reader.getFeature(ENTITY_RESOLVER_2_FEATURE)) { - reader.setFeature(ENTITY_RESOLVER_2_FEATURE, true); - } - } catch (SAXNotRecognizedException meansFeatureNotSupported) { - } - // Prevent loading of external DTDs - reader.setFeature("http://apache.org/xml/features/nonvalidating/load...;, false); - // Parse XML document - reader.parse(new InputSource(stream)); - } catch (Exception err) { - LOGGER.error(err, RepositoryI18n.errorSequencingXmlDocument); - } finally { - monitor.done(); - } - } + /** + * <p> + * {@inheritDoc} + * </p> + * + * @see org.jboss.dna.spi.sequencers.StreamSequencer#sequence(java.io.InputStream, + * org.jboss.dna.spi.sequencers.SequencerOutput, org.jboss.dna.common.monitor.ProgressMonitor) + */ + public void sequence( InputStream stream, + SequencerOutput output, + ProgressMonitor monitor ) { + monitor.beginTask(100.0, RepositoryI18n.sequencingXmlDocument); + XMLReader reader; + try { + reader = XMLReaderFactory.createXMLReader(); + Handler handler = new Handler(output, monitor); + reader.setContentHandler(handler); + reader.setErrorHandler(handler); + // Ensure handler acting as entity resolver 2 + reader.setProperty(DECL_HANDLER_FEATURE, handler); + // Ensure handler acting as lexical handler + reader.setProperty(LEXICAL_HANDLER_FEATURE, handler); + // Ensure handler acting as entity resolver 2 + try { + if (!reader.getFeature(ENTITY_RESOLVER_2_FEATURE)) { + reader.setFeature(ENTITY_RESOLVER_2_FEATURE, true); + } + } catch (SAXNotRecognizedException meansFeatureNotSupported) { + } + // Prevent loading of external DTDs + reader.setFeature("http://apache.org/xml/features/nonvalidating/load...;, false); + // Parse XML document + reader.parse(new InputSource(stream)); + } catch (Exception err) { + LOGGER.error(err, RepositoryI18n.errorSequencingXmlDocument); + } finally { + monitor.done(); + } + } - private class Handler extends DefaultHandler2 { + private class Handler extends DefaultHandler2 { - private ProgressMonitor monitor; - private SequencerOutput output; - private double progress; + private ProgressMonitor monitor; + private SequencerOutput output; + private double progress; - private Path path; // The DNA path of the node representing the current XML element + private Path path; // The DNA path of the node representing the current XML element - // Cached instances of the name factory and commonly referenced names - private NameFactory nameFactory; - private Name commentContentName; - private Name commentName; - private Name elementContentName; - private Name primaryTypeName; - private Name targetName; + // Cached instances of the name factory and commonly referenced names + private NameFactory nameFactory; + private Name commentContentName; + private Name commentName; + private Name elementContentName; + private Name primaryTypeName; + private Name targetName; - // Recursive map used to track the number of occurrences of names for elements under a particular path - private Map<Name, List<IndexedName>> nameToIndexedNamesMap = new HashMap<Name, List<IndexedName>>(); + // Recursive map used to track the number of occurrences of names for elements under a particular path + private Map<Name, List<IndexedName>> nameToIndexedNamesMap = new HashMap<Name, List<IndexedName>>(); - // The stack of recursive maps being processed, with the head entry being the map for the current path - private LinkedList<Map<Name, List<IndexedName>>> nameToIndexedNamesMapStack = new LinkedList<Map<Name, List<IndexedName>>>(); + // The stack of recursive maps being processed, with the head entry being the map for the current path + private LinkedList<Map<Name, List<IndexedName>>> nameToIndexedNamesMapStack = new LinkedList<Map<Name, List<IndexedName>>>(); - // The stack of XML namespace in scope, with the head entry being namespace of the closest ancestor element declaring a - // namespace. - private LinkedList<String> nsStack = new LinkedList<String>(); + // The stack of XML namespace in scope, with the head entry being namespace of the closest ancestor element declaring a + // namespace. + private LinkedList<String> nsStack = new LinkedList<String>(); - // Builder used to concatenate concurrent lines of CDATA into a single value. - private StringBuilder cDataBuilder; + // Builder used to concatenate concurrent lines of CDATA into a single value. + private StringBuilder cDataBuilder; - // Builder used to concatenate concurrent lines of element content and entity evaluations into a single value. - private StringBuilder contentBuilder; + // Builder used to concatenate concurrent lines of element content and entity evaluations into a single value. + private StringBuilder contentBuilder; - // The entity being processed - private String entity; + // The entity being processed + private String entity; - Handler( SequencerOutput output, - ProgressMonitor monitor ) { - this.output = output; - this.monitor = monitor; - // Initialize path to a an empty path relative to the SequencerOutput's target path. - path = output.getFactories().getPathFactory().createRelativePath(); - // Cache name factory since it is frequently used - nameFactory = output.getFactories().getNameFactory(); - } + Handler( SequencerOutput output, + ProgressMonitor monitor ) { + this.output = output; + this.monitor = monitor; + // Initialize path to a an empty path relative to the SequencerOutput's target path. + path = output.getFactories().getPathFactory().createRelativePath(); + // Cache name factory since it is frequently used + nameFactory = output.getFactories().getNameFactory(); + } - /** - * <p> - * {@inheritDoc} - * </p> - * - * @see org.xml.sax.ext.DefaultHandler2#attributeDecl(java.lang.String, java.lang.String, java.lang.String, - * java.lang.String, java.lang.String) - */ - @Override - public void attributeDecl( String name, - String name2, - String type, - String mode, - String value ) throws SAXException { - stopIfCancelled(); - } + /** + * <p> + * {@inheritDoc} + * </p> + * + * @see org.xml.sax.ext.DefaultHandler2#attributeDecl(java.lang.String, java.lang.String, java.lang.String, + * java.lang.String, java.lang.String) + */ + @Override + public void attributeDecl( String name, + String name2, + String type, + String mode, + String value ) throws SAXException { + stopIfCancelled(); + } - /** - * <p> - * {@inheritDoc} - * </p> - * - * @see org.xml.sax.helpers.DefaultHandler#characters(char[], int, int) - */ - @Override - public void characters( char[] ch, - int start, - int length ) throws SAXException { - stopIfCancelled(); - String content = String.valueOf(ch, start, length); - // Check if data should be appended to previously parsed CDATA - if (cDataBuilder == null) { - // If content is for an entity, replace with entity reference - if (entity != null) { - content = '&' + entity + ';'; - } - // Check if first line of content - if (contentBuilder == null) { - contentBuilder = new StringBuilder(content); - } else { - // Append additional lines or entity evaluations to previous content, separated by a space - if (entity == null) { - contentBuilder.append(' '); - } - contentBuilder.append(content); - // Text within builder will be output when another element or CDATA is encountered - } - } else { - cDataBuilder.append(ch, start, length); - // Text within builder will be output at the end of CDATA - } - updateProgress(); - } + /** + * <p> + * {@inheritDoc} + * </p> + * + * @see org.xml.sax.helpers.DefaultHandler#characters(char[], int, int) + */ + @Override + public void characters( char[] ch, + int start, + int length ) throws SAXException { + stopIfCancelled(); + String content = String.valueOf(ch, start, length); + // Check if data should be appended to previously parsed CDATA + if (cDataBuilder == null) { + // If content is for an entity, replace with entity reference + if (entity != null) { + content = '&' + entity + ';'; + } + // Check if first line of content + if (contentBuilder == null) { + contentBuilder = new StringBuilder(content); + } else { + // Append additional lines or entity evaluations to previous content, separated by a space + if (entity == null) { + contentBuilder.append(' '); + } + contentBuilder.append(content); + // Text within builder will be output when another element or CDATA is encountered + } + } else { + cDataBuilder.append(ch, start, length); + // Text within builder will be output at the end of CDATA + } + updateProgress(); + } - /** - * <p> - * {@inheritDoc} - * </p> - * - * @see org.xml.sax.ext.DefaultHandler2#comment(char[], int, int) - */ - @Override - public void comment( char[] ch, - int start, - int length ) throws SAXException { - stopIfCancelled(); - // Output separate nodes for each comment since multiple are allowed - startElement(getCommentName()); - output.setProperty(path, getPrimaryTypeName(), getCommentName()); - output.setProperty(path, getCommentContentName(), String.valueOf(ch, start, length)); - endElement(); - updateProgress(); - } + /** + * <p> + * {@inheritDoc} + * </p> + * + * @see org.xml.sax.ext.DefaultHandler2#comment(char[], int, int) + */ + @Override + public void comment( char[] ch, + int start, + int length ) throws SAXException { + stopIfCancelled(); + // Output separate nodes for each comment since multiple are allowed + startElement(getCommentName()); + output.setProperty(path, getPrimaryTypeName(), getCommentName()); + output.setProperty(path, getCommentContentName(), String.valueOf(ch, start, length)); + endElement(); + updateProgress(); + } - /** - * <p> - * {@inheritDoc} - * </p> - * - * @see org.xml.sax.ext.DefaultHandler2#elementDecl(java.lang.String, java.lang.String) - */ - @Override - public void elementDecl( String name, - String model ) throws SAXException { - stopIfCancelled(); - } + /** + * <p> + * {@inheritDoc} + * </p> + * + * @see org.xml.sax.ext.DefaultHandler2#elementDecl(java.lang.String, java.lang.String) + */ + @Override + public void elementDecl( String name, + String model ) throws SAXException { + stopIfCancelled(); + } - /** - * <p> - * {@inheritDoc} - * </p> - * - * @see org.xml.sax.ext.DefaultHandler2#endCDATA() - */ - @Override - public void endCDATA() throws SAXException { - stopIfCancelled(); - // Output CDATA built in characters() method - output.setProperty(path, nameFactory.create(CDATA_CONTENT), cDataBuilder.toString()); - endElement(); - // Null-out builder to free memory - cDataBuilder = null; - updateProgress(); - } + /** + * <p> + * {@inheritDoc} + * </p> + * + * @see org.xml.sax.ext.DefaultHandler2#endCDATA() + */ + @Override + public void endCDATA() throws SAXException { + stopIfCancelled(); + // Output CDATA built in characters() method + output.setProperty(path, nameFactory.create(CDATA_CONTENT), cDataBuilder.toString()); + endElement(); + // Null-out builder to free memory + cDataBuilder = null; + updateProgress(); + } - private void endContent() { - if (contentBuilder != null) { - // Normalize content - String content = StringUtil.normalize(contentBuilder.toString()); - // Null-out builder to setup for subsequent content. - // Must be done before call to startElement below to prevent infinite loop. - contentBuilder = null; - // Skip if nothing in content but whitespace - if (content.length() > 0) { - // Create separate node for each content entry since entries can be interspersed amongst child elements - startElement(getElementContentName()); - output.setProperty(path, getPrimaryTypeName(), getElementContentName()); - output.setProperty(path, getElementContentName(), content); - endElement(); - } - } - } + private void endContent() { + if (contentBuilder != null) { + // Normalize content + String content = StringUtil.normalize(contentBuilder.toString()); + // Null-out builder to setup for subsequent content. + // Must be done before call to startElement below to prevent infinite loop. + contentBuilder = null; + // Skip if nothing in content but whitespace + if (content.length() > 0) { + // Create separate node for each content entry since entries can be interspersed amongst child elements + startElement(getElementContentName()); + output.setProperty(path, getPrimaryTypeName(), getElementContentName()); + output.setProperty(path, getElementContentName(), content); + endElement(); + } + } + } - /** - * <p> - * {@inheritDoc} - * </p> - * - * @see org.xml.sax.helpers.DefaultHandler#endDocument() - */ - @Override - public void endDocument() throws SAXException { - stopIfCancelled(); - } + /** + * <p> + * {@inheritDoc} + * </p> + * + * @see org.xml.sax.helpers.DefaultHandler#endDocument() + */ + @Override + public void endDocument() throws SAXException { + stopIfCancelled(); + } - /** - * <p> - * {@inheritDoc} - * </p> - * - * @see org.xml.sax.ext.DefaultHandler2#endDTD() - */ - @Override - public void endDTD() throws SAXException { - stopIfCancelled(); - } + /** + * <p> + * {@inheritDoc} + * </p> + * + * @see org.xml.sax.ext.DefaultHandler2#endDTD() + */ + @Override + public void endDTD() throws SAXException { + stopIfCancelled(); + } - private void endElement() { - // Recover parent's path, namespace, and indexedName map, clearing the ended element's map to free memory - path = path.getAncestor(); - nameToIndexedNamesMap.clear(); - nameToIndexedNamesMap = nameToIndexedNamesMapStack.removeFirst(); - nsStack.removeFirst(); - } + private void endElement() { + // Recover parent's path, namespace, and indexedName map, clearing the ended element's map to free memory + path = path.getAncestor(); + nameToIndexedNamesMap.clear(); + nameToIndexedNamesMap = nameToIndexedNamesMapStack.removeFirst(); + nsStack.removeFirst(); + } - /** - * <p> - * {@inheritDoc} - * </p> - * - * @see org.xml.sax.helpers.DefaultHandler#endElement(java.lang.String, java.lang.String, java.lang.String) - */ - @Override - public void endElement( String uri, - String localName, - String name ) throws SAXException { - stopIfCancelled(); - // Check if content still needs to be output - endContent(); - endElement(); - updateProgress(); - } + /** + * <p> + * {@inheritDoc} + * </p> + * + * @see org.xml.sax.helpers.DefaultHandler#endElement(java.lang.String, java.lang.String, java.lang.String) + */ + @Override + public void endElement( String uri, + String localName, + String name ) throws SAXException { + stopIfCancelled(); + // Check if content still needs to be output + endContent(); + endElement(); + updateProgress(); + } - /** - * <p> - * {@inheritDoc} - * </p> - * - * @see org.xml.sax.ext.DefaultHandler2#endEntity(java.lang.String) - */ - @Override - public void endEntity( String name ) throws SAXException { - stopIfCancelled(); - entity = null; - updateProgress(); - } + /** + * <p> + * {@inheritDoc} + * </p> + * + * @see org.xml.sax.ext.DefaultHandler2#endEntity(java.lang.String) + */ + @Override + public void endEntity( String name ) throws SAXException { + stopIfCancelled(); + entity = null; + updateProgress(); + } - /** - * <p> - * {@inheritDoc} - * </p> - * - * @see org.xml.sax.helpers.DefaultHandler#error(org.xml.sax.SAXParseException) - */ - @Override - public void error( SAXParseException error ) throws SAXException { - LOGGER.error(error, RepositoryI18n.errorSequencingXmlDocument); - } + /** + * <p> + * {@inheritDoc} + * </p> + * + * @see org.xml.sax.helpers.DefaultHandler#error(org.xml.sax.SAXParseException) + */ + @Override + public void error( SAXParseException error ) { + LOGGER.error(error, RepositoryI18n.errorSequencingXmlDocument); + } - /** - * <p> - * {@inheritDoc} - * </p> - * - * @see org.xml.sax.ext.DefaultHandler2#externalEntityDecl(java.lang.String, java.lang.String, java.lang.String) - */ - @Override - public void externalEntityDecl( String name, - String publicId, - String systemId ) throws SAXException { - stopIfCancelled(); - // Add "synthetic" entity container to path to help prevent name collisions with XML elements - Name entityName = nameFactory.create(ENTITY); - startElement(entityName); - output.setProperty(path, getPrimaryTypeName(), entityName); - output.setProperty(path, nameFactory.create(DTD_NAME), name); - output.setProperty(path, nameFactory.create(DTD_PUBLIC_ID), publicId); - output.setProperty(path, nameFactory.create(DTD_SYSTEM_ID), systemId); - endElement(); - updateProgress(); - } + /** + * <p> + * {@inheritDoc} + * </p> + * + * @see org.xml.sax.ext.DefaultHandler2#externalEntityDecl(java.lang.String, java.lang.String, java.lang.String) + */ + @Override + public void externalEntityDecl( String name, + String publicId, + String systemId ) throws SAXException { + stopIfCancelled(); + // Add "synthetic" entity container to path to help prevent name collisions with XML elements + Name entityName = nameFactory.create(ENTITY); + startElement(entityName); + output.setProperty(path, getPrimaryTypeName(), entityName); + output.setProperty(path, nameFactory.create(DTD_NAME), name); + output.setProperty(path, nameFactory.create(DTD_PUBLIC_ID), publicId); + output.setProperty(path, nameFactory.create(DTD_SYSTEM_ID), systemId); + endElement(); + updateProgress(); + } - /** - * <p> - * {@inheritDoc} - * </p> - * - * @see org.xml.sax.helpers.DefaultHandler#fatalError(org.xml.sax.SAXParseException) - */ - @Override - public void fatalError( SAXParseException error ) throws SAXException { - LOGGER.error(error, RepositoryI18n.errorSequencingXmlDocument); - } + /** + * <p> + * {@inheritDoc} + * </p> + * + * @see org.xml.sax.helpers.DefaultHandler#fatalError(org.xml.sax.SAXParseException) + */ + @Override + public void fatalError( SAXParseException error ) { + LOGGER.error(error, RepositoryI18n.errorSequencingXmlDocument); + } - private Name getCommentContentName() { - if (commentContentName == null) { - commentContentName = nameFactory.create(COMMENT_CONTENT); - } - return commentContentName; - } + private Name getCommentContentName() { + if (commentContentName == null) { + commentContentName = nameFactory.create(COMMENT_CONTENT); + } + return commentContentName; + } - private Name getCommentName() { - if (commentName == null) { - commentName = nameFactory.create(COMMENT); - } - return commentName; - } + private Name getCommentName() { + if (commentName == null) { + commentName = nameFactory.create(COMMENT); + } + return commentName; + } - private Name getElementContentName() { - if (elementContentName == null) { - elementContentName = nameFactory.create(ELEMENT_CONTENT); - } - return elementContentName; - } + private Name getElementContentName() { + if (elementContentName == null) { + elementContentName = nameFactory.create(ELEMENT_CONTENT); + } + return elementContentName; + } - private Name getPrimaryTypeName() { - if (primaryTypeName == null) { - primaryTypeName = nameFactory.create(NameFactory.JCR_PRIMARY_TYPE); - } - return primaryTypeName; - } + private Name getPrimaryTypeName() { + if (primaryTypeName == null) { + primaryTypeName = nameFactory.create(NameFactory.JCR_PRIMARY_TYPE); + } + return primaryTypeName; + } - private Name getTargetName() { - if (targetName == null) { - targetName = nameFactory.create(TARGET); - } - return targetName; - } + private Name getTargetName() { + if (targetName == null) { + targetName = nameFactory.create(TARGET); + } + return targetName; + } - /** - * <p> - * {@inheritDoc} - * </p> - * - * @see org.xml.sax.helpers.DefaultHandler#ignorableWhitespace(char[], int, int) - */ - @Override - public void ignorableWhitespace( char[] ch, - int start, - int length ) throws SAXException { - stopIfCancelled(); - } + /** + * <p> + * {@inheritDoc} + * </p> + * + * @see org.xml.sax.helpers.DefaultHandler#ignorableWhitespace(char[], int, int) + */ + @Override + public void ignorableWhitespace( char[] ch, + int start, + int length ) throws SAXException { + stopIfCancelled(); + } - /** - * <p> - * {@inheritDoc} - * </p> - * - * @see org.xml.sax.ext.DefaultHandler2#internalEntityDecl(java.lang.String, java.lang.String) - */ - @Override - public void internalEntityDecl( String name, - String value ) throws SAXException { - stopIfCancelled(); - // Add "synthetic" entity container to path to help prevent name collisions with XML elements - Name entityName = nameFactory.create(ENTITY); - startElement(entityName); - output.setProperty(path, getPrimaryTypeName(), entityName); - output.setProperty(path, nameFactory.create(DTD_NAME), name); - output.setProperty(path, nameFactory.create(DTD_VALUE), value); - endElement(); - updateProgress(); - } + /** + * <p> + * {@inheritDoc} + * </p> + * + * @see org.xml.sax.ext.DefaultHandler2#internalEntityDecl(java.lang.String, java.lang.String) + */ + @Override + public void internalEntityDecl( String name, + String value ) throws SAXException { + stopIfCancelled(); + // Add "synthetic" entity container to path to help prevent name collisions with XML elements + Name entityName = nameFactory.create(ENTITY); + startElement(entityName); + output.setProperty(path, getPrimaryTypeName(), entityName); + output.setProperty(path, nameFactory.create(DTD_NAME), name); + output.setProperty(path, nameFactory.create(DTD_VALUE), value); + endElement(); + updateProgress(); + } - /** - * <p> - * {@inheritDoc} - * </p> - * - * @see org.xml.sax.helpers.DefaultHandler#notationDecl(java.lang.String, java.lang.String, java.lang.String) - */ - @Override - public void notationDecl( String name, - String publicId, - String systemId ) throws SAXException { - stopIfCancelled(); - } + /** + * <p> + * {@inheritDoc} + * </p> + * + * @see org.xml.sax.helpers.DefaultHandler#notationDecl(java.lang.String, java.lang.String, java.lang.String) + */ + @Override + public void notationDecl( String name, + String publicId, + String systemId ) throws SAXException { + stopIfCancelled(); + } - /** - * <p> - * {@inheritDoc} - * </p> - * - * @see org.xml.sax.helpers.DefaultHandler#processingInstruction(java.lang.String, java.lang.String) - */ - @Override - public void processingInstruction( String target, - String data ) throws SAXException { - stopIfCancelled(); - // Output separate nodes for each instruction since multiple are allowed - Name name = nameFactory.create(PI); - startElement(name); - output.setProperty(path, getPrimaryTypeName(), name); - output.setProperty(path, getTargetName(), target); - output.setProperty(path, nameFactory.create(PI_CONTENT), data); - endElement(); - updateProgress(); - } + /** + * <p> + * {@inheritDoc} + * </p> + * + * @see org.xml.sax.helpers.DefaultHandler#processingInstruction(java.lang.String, java.lang.String) + */ + @Override + public void processingInstruction( String target, + String data ) throws SAXException { + stopIfCancelled(); + // Output separate nodes for each instruction since multiple are allowed + Name name = nameFactory.create(PI); + startElement(name); + output.setProperty(path, getPrimaryTypeName(), name); + output.setProperty(path, getTargetName(), target); + output.setProperty(path, nameFactory.create(PI_CONTENT), data); + endElement(); + updateProgress(); + } - /** - * <p> - * {@inheritDoc} - * </p> - * - * @see org.xml.sax.helpers.DefaultHandler#skippedEntity(java.lang.String) - */ - @Override - public void skippedEntity( String name ) throws SAXException { - stopIfCancelled(); - } + /** + * <p> + * {@inheritDoc} + * </p> + * + * @see org.xml.sax.helpers.DefaultHandler#skippedEntity(java.lang.String) + */ + @Override + public void skippedEntity( String name ) throws SAXException { + stopIfCancelled(); + } - /** - * <p> - * {@inheritDoc} - * </p> - * - * @see org.xml.sax.ext.DefaultHandler2#startCDATA() - */ - @Override - public void startCDATA() throws SAXException { - stopIfCancelled(); - // Output separate nodes for each CDATA since multiple are allowed - startElement(nameFactory.create(CDATA)); - // Prepare builder for concatenating consecutive lines of CDATA - cDataBuilder = new StringBuilder(); - updateProgress(); - } + /** + * <p> + * {@inheritDoc} + * </p> + * + * @see org.xml.sax.ext.DefaultHandler2#startCDATA() + */ + @Override + public void startCDATA() throws SAXException { + stopIfCancelled(); + // Output separate nodes for each CDATA since multiple are allowed + startElement(nameFactory.create(CDATA)); + // Prepare builder for concatenating consecutive lines of CDATA + cDataBuilder = new StringBuilder(); + updateProgress(); + } - /** - * <p> - * {@inheritDoc} - * </p> - * - * @see org.xml.sax.helpers.DefaultHandler#startDocument() - */ - @Override - public void startDocument() throws SAXException { - stopIfCancelled(); - output.setProperty(path, getPrimaryTypeName(), nameFactory.create(DOCUMENT)); - updateProgress(); - } + /** + * <p> + * {@inheritDoc} + * </p> + * + * @see org.xml.sax.helpers.DefaultHandler#startDocument() + */ + @Override + public void startDocument() throws SAXException { + stopIfCancelled(); + output.setProperty(path, getPrimaryTypeName(), nameFactory.create(DOCUMENT)); + updateProgress(); + } - /** - * <p> - * {@inheritDoc} - * </p> - * - * @see org.xml.sax.ext.DefaultHandler2#startDTD(java.lang.String, java.lang.String, java.lang.String) - */ - @Override - public void startDTD( String name, - String publicId, - String systemId ) throws SAXException { - stopIfCancelled(); - output.setProperty(path, nameFactory.create(DTD_NAME), name); - output.setProperty(path, nameFactory.create(DTD_PUBLIC_ID), publicId); - output.setProperty(path, nameFactory.create(DTD_SYSTEM_ID), systemId); - updateProgress(); - } + /** + * <p> + * {@inheritDoc} + * </p> + * + * @see org.xml.sax.ext.DefaultHandler2#startDTD(java.lang.String, java.lang.String, java.lang.String) + */ + @Override + public void startDTD( String name, + String publicId, + String systemId ) throws SAXException { + stopIfCancelled(); + output.setProperty(path, nameFactory.create(DTD_NAME), name); + output.setProperty(path, nameFactory.create(DTD_PUBLIC_ID), publicId); + output.setProperty(path, nameFactory.create(DTD_SYSTEM_ID), systemId); + updateProgress(); + } - private void startElement( Name name ) { - // Check if content still needs to be output - endContent(); - // Add name to list of indexed names for this element to ensure we use the correct index (which is the size of the - // list) - List<IndexedName> indexedNames = nameToIndexedNamesMap.get(name); - if (indexedNames == null) { - indexedNames = new ArrayList<IndexedName>(); - nameToIndexedNamesMap.put(name, indexedNames); - } - IndexedName indexedName = new IndexedName(); - indexedNames.add(indexedName); - // Add element name and the appropriate index to the path. - // Per the JCR spec, the index must be relative to same-name sibling nodes - path = output.getFactories().getPathFactory().create(path, name, indexedNames.size()); - // Add the indexed name map to the stack and set the current map to the new element's map - nameToIndexedNamesMapStack.addFirst(nameToIndexedNamesMap); - nameToIndexedNamesMap = indexedName.nameToIndexedNamesMap; - // Set the current namespace to whatever is declared by this element, or if not declared, to its nearest ancestor that - // does declare a namespace. - String ns = name.getNamespaceUri(); - if (ns.length() == 0) { - nsStack.addFirst(nsStack.isEmpty() ? "" : nsStack.getFirst()); - } else { - nsStack.addFirst(ns); - } - } + private void startElement( Name name ) { + // Check if content still needs to be output + endContent(); + // Add name to list of indexed names for this element to ensure we use the correct index (which is the size of the + // list) + List<IndexedName> indexedNames = nameToIndexedNamesMap.get(name); + if (indexedNames == null) { + indexedNames = new ArrayList<IndexedName>(); + nameToIndexedNamesMap.put(name, indexedNames); + } + IndexedName indexedName = new IndexedName(); + indexedNames.add(indexedName); + // Add element name and the appropriate index to the path. + // Per the JCR spec, the index must be relative to same-name sibling nodes + path = output.getFactories().getPathFactory().create(path, name, indexedNames.size()); + // Add the indexed name map to the stack and set the current map to the new element's map + nameToIndexedNamesMapStack.addFirst(nameToIndexedNamesMap); + nameToIndexedNamesMap = indexedName.nameToIndexedNamesMap; + // Set the current namespace to whatever is declared by this element, or if not declared, to its nearest ancestor that + // does declare a namespace. + String ns = name.getNamespaceUri(); + if (ns.length() == 0) { + nsStack.addFirst(nsStack.isEmpty() ? "" : nsStack.getFirst()); + } else { + nsStack.addFirst(ns); + } + } - /** - * <p> - * {@inheritDoc} - * </p> - * - * @see org.xml.sax.helpers.DefaultHandler#startElement(java.lang.String, java.lang.String, java.lang.String, - * org.xml.sax.Attributes) - */ - @Override - public void startElement( String uri, - String localName, - String name, - Attributes attributes ) throws SAXException { - stopIfCancelled(); - startElement(nameFactory.create(name)); - output.setProperty(path, getPrimaryTypeName(), nameFactory.create(uri, localName)); - // Output this element's attributes using the attribute's namespace, if supplied, or the current namespace in scope. - String inheritedNs = nsStack.getFirst(); - for (int ndx = 0, len = attributes.getLength(); ndx < len; ++ndx) { - String ns = attributes.getURI(ndx); - output.setProperty(path, - nameFactory.create(ns.length() == 0 ? inheritedNs : ns, attributes.getLocalName(ndx)), - attributes.getValue(ndx)); - } - updateProgress(); - } + /** + * <p> + * {@inheritDoc} + * </p> + * + * @see org.xml.sax.helpers.DefaultHandler#startElement(java.lang.String, java.lang.String, java.lang.String, + * org.xml.sax.Attributes) + */ + @Override + public void startElement( String uri, + String localName, + String name, + Attributes attributes ) throws SAXException { + stopIfCancelled(); + startElement(nameFactory.create(name)); + output.setProperty(path, getPrimaryTypeName(), nameFactory.create(uri, localName)); + // Output this element's attributes using the attribute's namespace, if supplied, or the current namespace in scope. + String inheritedNs = nsStack.getFirst(); + for (int ndx = 0, len = attributes.getLength(); ndx < len; ++ndx) { + String ns = attributes.getURI(ndx); + output.setProperty(path, + nameFactory.create(ns.length() == 0 ? inheritedNs : ns, attributes.getLocalName(ndx)), + attributes.getValue(ndx)); + } + updateProgress(); + } - /** - * <p> - * {@inheritDoc} - * </p> - * - * @see org.xml.sax.ext.DefaultHandler2#startEntity(java.lang.String) - */ - @Override - public void startEntity( String name ) throws SAXException { - stopIfCancelled(); - entity = name; - updateProgress(); - } + /** + * <p> + * {@inheritDoc} + * </p> + * + * @see org.xml.sax.ext.DefaultHandler2#startEntity(java.lang.String) + */ + @Override + public void startEntity( String name ) throws SAXException { + stopIfCancelled(); + entity = name; + updateProgress(); + } - /** - * <p> - * {@inheritDoc} - * </p> - * - * @see org.xml.sax.helpers.DefaultHandler#startPrefixMapping(java.lang.String, java.lang.String) - */ - @Override - public void startPrefixMapping( String prefix, - String uri ) throws SAXException { - stopIfCancelled(); - // Register any unregistered namespaces - NamespaceRegistry registry = output.getNamespaceRegistry(); - if (!registry.isRegisteredNamespaceUri(uri)) { - registry.register(prefix, uri); - } - updateProgress(); - } + /** + * <p> + * {@inheritDoc} + * </p> + * + * @see org.xml.sax.helpers.DefaultHandler#startPrefixMapping(java.lang.String, java.lang.String) + */ + @Override + public void startPrefixMapping( String prefix, + String uri ) throws SAXException { + stopIfCancelled(); + // Register any unregistered namespaces + NamespaceRegistry registry = output.getNamespaceRegistry(); + if (!registry.isRegisteredNamespaceUri(uri)) { + registry.register(prefix, uri); + } + updateProgress(); + } - private void stopIfCancelled() throws SAXException { - if (monitor.isCancelled()) { - throw new SAXException(RepositoryI18n.canceledSequencingXmlDocument.text()); - } - } + private void stopIfCancelled() throws SAXException { + if (monitor.isCancelled()) { + throw new SAXException(RepositoryI18n.canceledSequencingXmlDocument.text()); + } + } - /** - * <p> - * {@inheritDoc} - * </p> - * - * @see org.xml.sax.helpers.DefaultHandler#unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, - * java.lang.String) - */ - @Override - public void unparsedEntityDecl( String name, - String publicId, - String systemId, - String notationName ) throws SAXException { - stopIfCancelled(); - } + /** + * <p> + * {@inheritDoc} + * </p> + * + * @see org.xml.sax.helpers.DefaultHandler#unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, + * java.lang.String) + */ + @Override + public void unparsedEntityDecl( String name, + String publicId, + String systemId, + String notationName ) throws SAXException { + stopIfCancelled(); + } - private void updateProgress() { - if (progress == 100.0) { - progress = 1; - } else { - progress++; - } - monitor.worked(progress); - } + private void updateProgress() { + if (progress == 100.0) { + progress = 1; + } else { + progress++; + } + monitor.worked(progress); + } - /** - * <p> - * {@inheritDoc} - * </p> - * - * @see org.xml.sax.helpers.DefaultHandler#warning(org.xml.sax.SAXParseException) - */ - @Override - public void warning( SAXParseException error ) throws SAXException { - LOGGER.warn(error, RepositoryI18n.errorSequencingXmlDocument); - } - } + /** + * <p> + * {@inheritDoc} + * </p> + * + * @see org.xml.sax.helpers.DefaultHandler#warning(org.xml.sax.SAXParseException) + */ + @Override + public void warning( SAXParseException error ) { + LOGGER.warn(error, RepositoryI18n.errorSequencingXmlDocument); + } + } - private class IndexedName { + private class IndexedName { - Map<Name, List<IndexedName>> nameToIndexedNamesMap = new HashMap<Name, List<IndexedName>>(); + Map<Name, List<IndexedName>> nameToIndexedNamesMap = new HashMap<Name, List<IndexedName>>(); - IndexedName() { - } - } + IndexedName() { + } + } }