org.netbeans.modules.web.struts.StrutsConfigDataObject Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.netbeans.modules.web.struts;
//import org.netbeans.modules.xml.catalog.settings.CatalogSettings;
import java.io.IOException;
import java.io.InputStream;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.netbeans.modules.web.struts.config.model.StrutsConfig;
import org.openide.filesystems.FileObject;
import org.openide.loaders.DataObjectExistsException;
import org.openide.loaders.MultiDataObject;
import org.openide.nodes.CookieSet;
import org.openide.nodes.Node;
import org.openide.util.Lookup;
import org.xml.sax.InputSource;
import org.netbeans.core.spi.multiview.MultiViewElement;
import org.netbeans.core.spi.multiview.text.MultiViewEditorElement;
import org.netbeans.modules.xml.api.XmlFileEncodingQueryImpl;
import org.netbeans.spi.queries.FileEncodingQueryImplementation;
import org.netbeans.spi.xml.cookies.*;
import org.openide.filesystems.MIMEResolver;
import org.openide.util.NbBundle.Messages;
import org.openide.windows.TopComponent;
import org.w3c.dom.Document;
import org.xml.sax.ErrorHandler;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;
/**
*
* @author Petr Pisl
*/
@MIMEResolver.NamespaceRegistration(
displayName="",
position=410,
mimeType="text/x-struts+xml",
doctypePublicId={
"-//Apache Software Foundation//DTD Struts Configuration 1.0//EN",
"-//Apache Software Foundation//DTD Struts Configuration 1.1//EN",
"-//Apache Software Foundation//DTD Struts Configuration 1.2//EN",
"-//Apache Software Foundation//DTD Struts Configuration 1.3//EN"
}
)
public class StrutsConfigDataObject extends MultiDataObject
implements org.openide.nodes.CookieSet.Factory {
private static StrutsCatalog strutsCatalog = new StrutsCatalog();
private boolean documentDirty = true;
private boolean documentValid=true;
protected boolean nodeDirty = false;
private InputStream inputStream;
private SAXParseError error;
private StrutsConfig lastGoodConfig = null;
/** Editor support for text data object. */
private transient StrutsConfigEditorSupport editorSupport;
/** Property name for property documentValid */
public static final String PROP_DOC_VALID = "documentValid"; // NOI18N
/** Creates a new instance of StrutsConfigDataObject */
public StrutsConfigDataObject(FileObject pf, StrutsConfigLoader loader) throws DataObjectExistsException {
super(pf, loader);
init();
}
private void init() {
CookieSet cookies = getCookieSet();
cookies.add(StrutsConfigEditorSupport.class, this);
cookies.assign(FileEncodingQueryImplementation.class, XmlFileEncodingQueryImpl.singleton());
// Creates Check XML and Validate XML context actions
InputSource in = DataObjectAdapters.inputSource(this);
cookies.add(new CheckXMLSupport(in));
cookies.add(new ValidateXMLSupport(in));
}
/**
* Provides node that should represent this data object. When a node for
* representation in a parent is requested by a call to getNode (parent)
* it is the exact copy of this node
* with only parent changed. This implementation creates instance
* DataNode.
*
* This method is called only once.
*
* @return the node representation for this data object
* @see DataNode
*/
protected synchronized Node createNodeDelegate () {
return new StrutsConfigNode(this);
}
@MultiViewElement.Registration(
displayName="#CTL_SourceTabCaption",
iconBase="org/netbeans/modules/web/struts/resources/StrutsConfigIcon.png",
persistenceType=TopComponent.PERSISTENCE_ONLY_OPENED,
preferredID="struts.config",
mimeType=StrutsConfigLoader.MIME_TYPE,
position=1
)
@Messages("CTL_SourceTabCaption=&Source")
public static MultiViewEditorElement createMultiViewEditorElement(Lookup context) {
return new MultiViewEditorElement(context);
}
/** Implements CookieSet.Factory interface. */
public Node.Cookie createCookie(Class clazz) {
if(clazz.isAssignableFrom(StrutsConfigEditorSupport.class))
return getEditorSupport();
else
return null;
}
@Override
protected int associateLookup() {
return 1;
}
/** Gets editor support for this data object. */
public StrutsConfigEditorSupport getEditorSupport() {
if(editorSupport == null) {
synchronized(this) {
if(editorSupport == null)
editorSupport = new StrutsConfigEditorSupport(this);
}
}
return editorSupport;
}
public StrutsConfig getStrutsConfig() throws java.io.IOException {
if (lastGoodConfig == null)
parsingDocument();
return lastGoodConfig;
}
public StrutsConfig getStrutsConfig (boolean parsenow) throws java.io.IOException{
if (parsenow){
StrutsConfig previous = lastGoodConfig;
parsingDocument();
if (lastGoodConfig == null)
lastGoodConfig = previous;
}
return getStrutsConfig();
}
/** This method is used for obtaining the current source of xml document.
* First try if document is in the memory. If not, provide the input from
* underlayed file object.
* @return The input source from memory or from file
* @exception IOException if some problem occurs
*/
protected InputStream prepareInputSource() throws java.io.IOException {
if ((getEditorSupport() != null) && (getEditorSupport().isDocumentLoaded())) {
// loading from the memory (Document)
return getEditorSupport().getInputStream();
}
else {
return getPrimaryFile().getInputStream();
}
}
/** This method has to be called everytime after prepareInputSource calling.
* It is used for closing the stream, because it is not possible to access the
* underlayed stream hidden in InputSource.
* It is save to call this method without opening.
*/
protected void closeInputSource() {
InputStream is = inputStream;
if (is != null) {
try {
is.close();
}
catch (IOException e) {
// nothing to do, if exception occurs during saving.
}
if (is == inputStream) {
inputStream = null;
}
}
}
public void write(StrutsConfig config) throws java.io.IOException {
java.io.File file = org.openide.filesystems.FileUtil.toFile(getPrimaryFile());
org.openide.filesystems.FileObject configFO = getPrimaryFile();
try {
org.openide.filesystems.FileLock lock = configFO.lock();
try {
java.io.OutputStream os =configFO.getOutputStream(lock);
try {
config.write(os);
} finally {
os.close();
}
}
finally {
lock.releaseLock();
}
} catch (org.openide.filesystems.FileAlreadyLockedException ex) {
// PENDING should write a message
}
}
/** This method parses XML document and calls updateNode method which
* updates corresponding Node.
*/
public void parsingDocument(){
error = null;
try {
error = updateNode(prepareInputSource());
}
catch (Exception e) {
Logger.getLogger("global").log(Level.INFO, null, e);
setDocumentValid(false);
return;
}
finally {
closeInputSource();
documentDirty=false;
}
if (error == null){
setDocumentValid(true);
}else {
setDocumentValid(false);
}
setNodeDirty(false);
}
public void setDocumentValid (boolean valid){
if (documentValid!=valid) {
if (valid)
repairNode();
documentValid=valid;
firePropertyChange (PROP_DOC_VALID, !documentValid ? Boolean.TRUE : Boolean.FALSE, documentValid ? Boolean.TRUE : Boolean.FALSE);
}
}
/** This method repairs Node Delegate (usually after changing document by property editor)
*/
protected void repairNode(){
// PENDING: set the icon in Node
// ((DataNode)getNodeDelegate()).setIconBase (getIconBaseForValidDocument());
org.openide.awt.StatusDisplayer.getDefault().setStatusText(""); // NOI18N
/* if (inOut!=null) {
inOut.closeInputOutput();
errorAnnotation.detach();
}*/
}
private org.w3c.dom.Document getDomDocument(InputStream inputSource) throws SAXParseException {
try {
// creating w3c document
org.w3c.dom.Document doc = org.netbeans.modules.schema2beans.GraphManager.
createXmlDocument(new org.xml.sax.InputSource(inputSource), false, strutsCatalog,
new J2eeErrorHandler(this));
return doc;
} catch(Exception e) {
// XXX Change that
throw new SAXParseException(e.getMessage(), new org.xml.sax.helpers.LocatorImpl());
}
}
/** Update the node from document. This method is called after document is changed.
* @param is Input source for the document
* @return number of the line with error (document is invalid), 0 (xml document is valid)
*/
// TODO is prepared for handling arrors, but not time to finish it.
protected SAXParseError updateNode(InputStream is) throws java.io.IOException{
try {
Document doc = getDomDocument(is);
lastGoodConfig = StrutsConfig.createGraph(doc);
} catch(SAXParseException ex) {
return new SAXParseError(ex);
}
return null;
}
public boolean isDocumentValid(){
return documentValid;
}
/** setter for property documentDirty. Method updateDocument() usually setsDocumentDirty to false
*/
public void setDocumentDirty(boolean dirty){
documentDirty=dirty;
}
/** Getter for property documentDirty.
* @return Value of property documentDirty.
*/
public boolean isDocumentDirty(){
return documentDirty;
}
/** Getter for property nodeDirty.
* @return Value of property nodeDirty.
*/
public boolean isNodeDirty(){
return nodeDirty;
}
/** Setter for property nodeDirty.
* @param dirty New value of property nodeDirty.
*/
public void setNodeDirty(boolean dirty){
nodeDirty=dirty;
}
org.openide.nodes.CookieSet getCookieSet0() {
return getCookieSet();
}
public static class J2eeErrorHandler implements ErrorHandler {
private StrutsConfigDataObject dataObject;
public J2eeErrorHandler(StrutsConfigDataObject obj) {
dataObject=obj;
}
public void error(SAXParseException exception) throws SAXException {
dataObject.createSAXParseError(exception);
throw exception;
}
public void fatalError(SAXParseException exception) throws SAXException {
dataObject.createSAXParseError(exception);
throw exception;
}
public void warning(SAXParseException exception) throws SAXException {
dataObject.createSAXParseError(exception);
throw exception;
}
}
private void createSAXParseError(SAXParseException error){
this.error = new SAXParseError(error);
}
}