<change id="MultiDataObject.associateLookup">

          <api name="loaders"/>

          <summary>Simpler way to subclass MultiDataObject</summary>

          <version major="7" minor="26"/>

          <date day="17" month="6" year="2011"/>

          <author login="jtulach"/>

          <compatibility semantic="compatible" binary="compatible" deletion="no"

            addition="yes" modification="yes" source="incompatible">

                Added <code>registerEditor</code> method which might clash

                with some existing method in subclasses, although it is 

                hopefully not very likely.

          </compatibility>

          <description>

              <p>

                  New way to subclass <code>MultiDataObject</code>: override

                  <a href="@TOP@/org/openide/loaders/MultiDataObject.html#associateLookup()">

                  int associateLookup()

                  </a> to return <code>1</code>. In constructor call

                  <a href="@TOP@/org/openide/loaders/MultiDataObject.html#registerEditor(java.lang.String,%20boolean)">

                  registerEditor("your/mimetype", ...)</a> to get default

                  editor support. No need to override any other methods to get

                  well performing <code>MultiDataObject</code>.

              </p>

          </description>

          <class package="org.openide.loaders" name="MultiDataObject"/>

      </change>

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2011 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2011 Sun Microsystems, Inc.

 */

package org.openide.loaders;

import java.io.Serializable;

import java.lang.reflect.Method;

import java.util.concurrent.Callable;

import java.util.logging.Level;

import org.netbeans.api.actions.Editable;

import org.netbeans.api.actions.Openable;

import org.openide.cookies.CloseCookie;

import org.openide.cookies.EditorCookie;

import org.openide.cookies.LineCookie;

import org.openide.cookies.PrintCookie;

import org.openide.nodes.CookieSet;

import org.openide.nodes.Node.Cookie;

import org.openide.text.CloneableEditorSupport;

import org.openide.text.CloneableEditorSupport.Pane;

import org.openide.text.DataEditorSupport;

import org.openide.util.Exceptions;

import org.openide.util.Lookup;

import org.openide.windows.CloneableOpenSupport;

/**

 *

 * @author Jaroslav Tulach <jtulach@netbeans.org>

 */

final class MultiDOEditor implements Callable<Pane>, CookieSet.Factory {

    private CloneableEditorSupport support;

    private static final Method factory;

    static {

        ClassLoader l = Lookup.getDefault().lookup(ClassLoader.class);

        if (l == null) {

            l = Thread.currentThread().getContextClassLoader();

        }

        if (l == null) {

            l = MultiDOEditor.class.getClassLoader();

        }

        Method m = null;

        try {

            Class<?> multiviews = Class.forName("org.netbeans.core.api.multiview.MultiViews", true, l); // NOI18N

            m = multiviews.getMethod("createCloneableMultiView", String.class, Serializable.class); // NOI18N

        } catch (NoSuchMethodException ex) {

            MultiDataObject.LOG.log(Level.WARNING, "Cannot find a method", ex); // NOI18N

        } catch (ClassNotFoundException ex) {

            MultiDataObject.LOG.info("Not using multiviews for MultiDataObject.registerEditor()"); // NOI18N

            MultiDataObject.LOG.log(Level.FINE, "Cannot find a class", ex); // NOI18N

        }

        factory = m;

    }

    private final MultiDataObject outer;

    private final String mimeType;

    private final boolean useMultiview;

    MultiDOEditor(MultiDataObject outer, String mimeType, boolean useMultiview) {

        this.outer = outer;

        this.mimeType = mimeType;

        this.useMultiview = useMultiview;

    }

    @Override

    public Pane call() throws Exception {

        if (factory != null) {

            return (Pane) factory.invoke(null, mimeType, outer);

        }

        return null;

    }

    @Override

    public <T extends Cookie> T createCookie(Class<T> klass) {

        if (

            klass.isAssignableFrom(DataEditorSupport.class) || 

            DataEditorSupport.class.isAssignableFrom(klass) || 

            klass.isAssignableFrom(Openable.class) || 

            klass.isAssignableFrom(Editable.class) || 

            klass.isAssignableFrom(EditorCookie.Observable.class) || 

            klass.isAssignableFrom(PrintCookie.class) || 

            klass.isAssignableFrom(CloseCookie.class) || 

            klass.isAssignableFrom(LineCookie.class)

        ) {

            synchronized (this) {

                if (support == null) {

                    support = DataEditorSupport.create(

                        outer, outer.getPrimaryEntry(),

                        outer.getCookieSet(), useMultiview ? this : null

                    );

                }

            }

            return klass.cast(support);

        }

        return null;

    }

    public static void registerEditor(MultiDataObject multi, String mime, boolean useMultiview) {

        MultiDOEditor ed = new MultiDOEditor(multi, mime, useMultiview);

        try {

            multi.getCookieSet().add(new Class[]{

                Class.forName("org.openide.text.SimpleES"), // NOI18N

                SaveAsCapable.class, Openable.class, EditorCookie.Observable.class, 

                PrintCookie.class, CloseCookie.class, Editable.class,

                DataEditorSupport.class, CloneableEditorSupport.class,

                CloneableOpenSupport.class

            }, ed);

        } catch (ClassNotFoundException ex) {

            throw new IllegalStateException(ex);

        }

    }

}

import java.lang.reflect.Method;

import java.util.concurrent.Callable;

import org.netbeans.api.actions.Editable;

import org.netbeans.api.actions.Openable;

import org.openide.cookies.CloseCookie;

import org.openide.cookies.EditorCookie;

import org.openide.cookies.LineCookie;

import org.openide.cookies.PrintCookie;

import org.openide.nodes.Node.Cookie;

import org.openide.text.CloneableEditor;

import org.openide.text.CloneableEditorSupport;

import org.openide.text.CloneableEditorSupport.Pane;

import org.openide.text.DataEditorSupport;

        if (associateLookup() >= 1) {

            return new DataNode(this, Children.LEAF, getLookup());

        }

    @Override

    public Lookup getLookup() {

        int version = associateLookup();

        assert version <= 1;

        if (version >= 1) {

            return getCookieSet().getLookup();

        }

        return super.getLookup();

    }

    /** Influences behavior of {@link #getLookup()} method. Depending on the

     * returned integer, one can get different, better and more modern  content 

     * of the {@link Lookup}:

     * <ul>

     * <li><b>version 0</b> - delegates to <code>getNodeDelegate().getLookup()</code>.</li>

     * <li><b>version 1</b> - delegates to <code>getCookieSet().getLookup()</code>

     *   and makes sure {@link FileObject}, <code>this</code> and 

     *   {@link Node} are in the lookup. The {@link Node} is created lazily

     *   by calling {@link #getNodeDelegate()}.

     * </li>

     * </ul>

     * General suggestion is to always return the highest supported version

     * when creating new objects and to stick with certain version when backward

     * compatibility is requested.

     * 

     * @return version identifying content of the lookup (currently 0 or 1)

     * @since 7.26

     */

    protected int associateLookup() {

        return 0;

    }

    /** Utility method to register editor for this {@link DataObject}.

     * Call it from constructor with appropriate mimeType. The system will

     * make sure that appropriate cookies ({@link Openable}, {@link Editable},

     * {@link CloseCookie}, {@link EditorCookie}, {@link SaveAsCapable},

     * {@link LineCookie} are registered into {@link #getCookieSet()}.

     * <p>

     * The selected editor is <a href="@org-netbeans-core-multiview@/org/netbeans/core/api/multiview/MultiViews.html">

     * MultiView component</a>, if requested (this requires presence of

     * the <a href="@org-netbeans-core-multiview@/overview-summary.html">MultiView API</a>

     * in the system. Otherwise it is plain {@link CloneableEditor}.

     * 

     * @param mimeType mime type to associate with

     * @param useMultiview should the used component be multiview?

     * @since 7.26

     */

    protected final void registerEditor(final String mimeType, boolean useMultiview) {

        MultiDOEditor.registerEditor(this, mimeType, useMultiview);

    }

    final void updateNodeInCookieSet() {

        if (associateLookup() >= 1) {

            CookieSet set = getCookieSet(false);

            if (set != null) {

                set.assign(Node.class, getNodeDelegate());

            }

        }

    }

        @Override

        @Override

            if (clazz.isAssignableFrom(Node.class)) {

                updateNodeInCookieSet();

            }

import org.openide.cookies.LineCookie;

import org.openide.loaders.SaveAsCapable;

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 1997-2010 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * Contributor(s):

 *

 * The Original Software is NetBeans. The Initial Developer of the Original

 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun

 * Microsystems, Inc. All Rights Reserved.

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 */

package org.openide.loaders;

import org.openide.filesystems.*;

import org.netbeans.junit.*;

import java.io.IOException;

import java.util.*;

import java.util.logging.Level;

import org.openide.*;

import org.openide.cookies.CloseCookie;

import org.openide.cookies.EditCookie;

import org.openide.cookies.EditorCookie;

import org.openide.cookies.LineCookie;

import org.openide.cookies.OpenCookie;

import org.openide.cookies.PrintCookie;

import org.openide.nodes.Node;

import org.openide.util.Enumerations;

public class MultiDataObjectVersion1Test extends NbTestCase {

    FileSystem fs;

    DataObject one;

    DataFolder from;

    DataFolder to;

    ErrorManager err;

    public MultiDataObjectVersion1Test (String name) {

        super (name);

    }

    @Override

    protected Level logLevel() {

        return Level.INFO;

    }

    @Override

    protected int timeOut() {

        return 45000;

    }

    @Override

    public void setUp() throws Exception {

        clearWorkDir();

        super.setUp();

        MockServices.setServices(Pool.class);

        err = ErrorManager.getDefault().getInstance("TEST-" + getName());

        LocalFileSystem lfs = new LocalFileSystem();

        lfs.setRootDirectory(getWorkDir());

        fs = lfs;

        FileUtil.createData(fs.getRoot(), "from/x.prima");

        FileUtil.createData(fs.getRoot(), "from/x.seconda");

        FileUtil.createFolder(fs.getRoot(), "to/");

        one = DataObject.find(fs.findResource("from/x.prima"));

        assertEquals(SimpleObject.class, one.getClass());

        from = one.getFolder();

        to = DataFolder.findFolder(fs.findResource("to/"));

        assertEquals("Nothing there", 0, to.getPrimaryFile().getChildren().length);

    }

    public void testWhatIsInTheLookup() throws Exception {

        assertTrue(this.one instanceof SimpleObject);

        SimpleObject s = (SimpleObject)this.one;

        assertEquals("DO in lookup", s, s.getLookup().lookup(DataObject.class));

        assertEquals("Fo in lookup", s.getPrimaryFile(), s.getLookup().lookup(FileObject.class));

        assertEquals("no node created yet", 0, s.cnt);

        Node lkpNd = s.getLookup().lookup(Node.class);

        assertEquals("now node created", 1, s.cnt);

        assertEquals("Node in lookup", s.getNodeDelegate(), lkpNd);

    }

    public void testEditorInLookup() throws Exception {

        assertTrue(this.one instanceof SimpleObject);

        SimpleObject s = (SimpleObject)this.one;

        LineCookie line = s.getLookup().lookup(LineCookie.class);

        assertNotNull("Line cookie is there", line);

        assertEquals("Edit cookie", line, s.getLookup().lookup(EditCookie.class));

        assertEquals("Editor cookie", line, s.getLookup().lookup(EditorCookie.class));

        assertEquals("Editor objservable cookie", line, s.getLookup().lookup(EditorCookie.Observable.class));

        assertEquals("SaveAsCapable", line, s.getLookup().lookup(SaveAsCapable.class));

        assertEquals("Open cookie", line, s.getLookup().lookup(OpenCookie.class));

        assertEquals("Close cookie", line, s.getLookup().lookup(CloseCookie.class));

        assertEquals("Print cookie", line, s.getLookup().lookup(PrintCookie.class));

    }

    public static final class Pool extends DataLoaderPool {

        @Override

        protected Enumeration loaders() {

            return Enumerations.singleton(SimpleLoader.getLoader(SimpleLoader.class));

        }

    }

    public static final class SimpleLoader extends MultiFileLoader {

        public SimpleLoader() {

            super(SimpleObject.class);

        }

        protected String displayName() {

            return "SimpleLoader";

        }

        @Override

        protected FileObject findPrimaryFile(FileObject fo) {

            if (!fo.isFolder()) {

                // emulate the behaviour of form data object

                /* emulate!? this one is written too well ;-)

                FileObject primary = FileUtil.findBrother(fo, "prima");

                FileObject secondary = FileUtil.findBrother(fo, "seconda");

                if (primary == null || secondary == null) {

                    return null;

                }

                if (primary != fo && secondary != fo) {

                    return null;

                }

                 */

                // here is the common code for the worse behaviour

                if (fo.hasExt("prima")) {

                    return FileUtil.findBrother(fo, "seconda") != null ? fo : null;

                }

                if (fo.hasExt("seconda")) {

                    return FileUtil.findBrother(fo, "prima");

                }

            }

            return null;

        }

        protected MultiDataObject createMultiObject(FileObject primaryFile) throws DataObjectExistsException, IOException {

            return new SimpleObject(this, primaryFile);

        }

        protected MultiDataObject.Entry createPrimaryEntry(MultiDataObject obj, FileObject primaryFile) {

            return new FileEntry(obj, primaryFile);

        }

        protected MultiDataObject.Entry createSecondaryEntry(MultiDataObject obj, FileObject secondaryFile) {

            return new FileEntry(obj, secondaryFile);

        }

    }

    public static final class SimpleObject extends MultiDataObject {

        private int cnt;

        public SimpleObject(SimpleLoader l, FileObject fo) throws DataObjectExistsException {

            super(fo, l);

            registerEditor("mime/type", false);

        }

        @Override

        protected int associateLookup() {

            return 1;

        }

        @Override

        protected Node createNodeDelegate() {

            cnt++;

            return super.createNodeDelegate();

        }

    }

}