/*
 *                 Sun Public License Notice
 * 
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 * 
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2003 Sun
 * Microsystems, Inc. All Rights Reserved.
 */
package org.netbeans.modules.xml.schema;

import javax.xml.transform.Source;

import org.openide.loaders.*;
import org.openide.filesystems.FileObject;
import org.openide.util.HelpCtx;
import org.openide.nodes.Node;
import org.openide.nodes.Children;
import org.openide.nodes.CookieSet;

import org.netbeans.modules.xml.core.XMLDataObjectLook;
import org.netbeans.modules.xml.core.text.TextEditorSupport;
import org.netbeans.modules.xml.core.sync.*;
import org.netbeans.modules.xml.core.cookies.*;

import org.netbeans.spi.xml.cookies.*;
import org.netbeans.modules.xml.schema.cookies.*;
import org.xml.sax.InputSource;

/**
 * XML Schema owner. It provides text editing and validation cookies
 * support.
 *
 * @author  Petr Kuzel
 */
public final class SchemaObject extends MultiDataObject implements XMLDataObjectLook {

    /** Serial Version UID */
    private static final long serialVersionUID = 290911236522999000L;

    private static final String SCHEMA_ICON_BASE =
        "org/netbeans/modules/xml/schema/resources/xmlSchemaObject";            // NOI18N
    
    private transient final DataObjectCookieManager cookieManager;

    private transient Synchronizator synchronizator;
    
    //
    // init
    //

    public SchemaObject(final FileObject obj, final UniFileLoader loader) throws DataObjectExistsException {
        super (obj, loader);

        CookieSet set = getCookieSet();
        cookieManager = new DataObjectCookieManager (this, set);
        set.add (cookieManager);
    
        // editor support defines MIME type understood by EditorKits registry         
        TextEditorSupport.TextEditorSupportFactory editorFactory =
            new TextEditorSupport.TextEditorSupportFactory (this, org.netbeans.modules.xml.core.XMLDataObject.MIME_TYPE);
        editorFactory.registerCookies (set);

        // add check and validate cookies
        InputSource is = DataObjectAdapters.inputSource(this);
        set.add(new CheckXMLSupport(is));
        set.add(new ValidateSchemaSupport(is));
        
        // add TransformableCookie
        Source source = DataObjectAdapters.source(this);
        set.add (new TransformableSupport (source));
    }


    /**
     */
    protected Node createNodeDelegate () {
        return new SchemaNode (this);
    }

    
    /**
     */
    public HelpCtx getHelpCtx() {
        return new HelpCtx (SchemaObject.class);
    }

    // XMLDataObjectLook to be deprecated ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    
    public DataObjectCookieManager getCookieManager() {
        return cookieManager;
    }

    public synchronized Synchronizator getSyncInterface() {
        if (synchronizator == null) {
            synchronizator = new DataObjectSyncSupport(SchemaObject.this);
        }
        return synchronizator;
    }
    
    /**
     * Redefine icon and help.
     */
    private static class SchemaNode extends DataNode {

        /** Create new EntityDataNode. */
        public SchemaNode (SchemaObject obj) {
            super (obj, Children.LEAF);
            setIconBase( SCHEMA_ICON_BASE);
            setShortDescription( Util.THIS.getString("PROP_SchemaNode_desc"));
        }

        /**
         */
        public HelpCtx getHelpCtx() {
            return new HelpCtx (SchemaObject.class);
        }
        
    }

}