* 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.

*/

* Main class implementing the multi page editor. In Eclipse 3, we extend FormEditor, which extends

* in turn MultiPageEditorPart.

*

* Life cycle: Create: An instance of this class is created each time the editor is started on a new

* resource. Base multipage editor createPartControl calls createPages; FormEditor's impl of

* createPages calls createToolkit, then calls addPages. FormEditor has field holding the toolkit

* This class overrides createToolkit to re-use the colors in the plugin. * Dispose: dispose is

* called. FormEditor impl of dispose disposes of the toolkit.

*

* Superclass (FormEditor) holds vector of pages toolkit (disposed of in FormEditor dispose method)

* SuperSuperclass (MultiPageEditorPart) holds array of editors (we only have 1 "editor" - the xml

* source editor - the rest are views into that model / data).

*

* Stale = model (on disk, saved) is ahead of widgets Dirty = widgets are ahead of model <<< NOT

* USED HERE

*

* Each page of the multipage editor has its own class. ownclass -> HeaderPage -> FormPage (impl

* IFormPage) has instance of PageForm -> ManagedForm ManagedForm (impl IManagedForm): has instance

* of ScrolledForm has subparts (IFormPart - which live on the scrolled form) A part can be a

* section. A part can implement IPartSelectionListener to get selectionChanged(IFormPart,

* ISelection) calls. initialize() call propagated to all parts. dispose() call propagated to all

* parts. refresh() propagated to all parts (if part.isStale()) (Not Used) commit() propagated to

* all parts (if part.isDirty()) setInput() propagated to all parts setFocus() propagated to 1st

* part (not used) isDirty() propagated to all parts, is true if any are true isStale() propagated

* to all parts, is true if any are true reflow() delegated to the contained ScrolledForm (not used)

* fireSelectionChanged(IFormPart, ISelection) - can be used to notify other parts that implement

* IPartSelectionListener about selection changes

*

* Each page has one or more sections. sectionSpecific -> (AbstractTableSection) -> AbstractSection ->

* SectionPart -> AbstractFormPart (impl IFormPart, see above)

*

* AbstractFormPart holds back ref to managed form, a dirty and stale bit. Stale = model is ahead of

* widgets (Not used) Dirty = widgets are ahead of model Stale brought into sync by 'refresh'

* method. Part notifies containing ManagedForm when Stale/Dirty changes in the part; Part

* responsible for removing listeners from event providers. IFormPart can receive form input

* SectionPart adds listeners for expansionStateChang(ed)(ing) expansionStateChanged calls reflow on

* wrapped form Note: the forms framework Dirty mechanism and the "commit" methods are not used. In

* its place, the handlers directly update the model, rather than marking Dirty and letting someone

* call commit.

*/

  // ******************************

  // * Tuning Parameters

  public final int INITIAL_SIZE_TYPE_COLLECTIONS = 20;

  public final int INITIAL_SIZE_FEATURE_COLLECTIONS = 40;

  // ******************************

  // ***********************************************************

  // M O D E L

  // the following are only populated based on what type

  // of descriptor is being edited

  protected AnalysisEngineDescription aeDescription = null;

  private TypeSystemDescription typeSystemDescription = null;

  private TypeSystemDescription mergedTypeSystemDescription = null;

 

  private Map mergedTypesAddingFeatures = new TreeMap();

  private TypeSystemDescription importedTypeSystemDescription = null;

  /**

   * Key = unique ID of included AE in aggregate Value = AnalysisEngineSpecification or URISpecifier

   * if remote This value is obtained from aeDescription.getDelegateAnalysisEngineSpecifiers() for

   * aggregates, and is cached so we don't need to repeatedly resolve it, with checks for invalid

   * xml exceptions.

   */

  private Map resolvedDelegates = new HashMap();

  // fully resolved (imports) and merged index collection

  // resolve with mergeDelegateAnalysisEngineFsIndexCollections

  // (This works also for primitives)

  private FsIndexCollection mergedFsIndexCollection;

  private FsIndexCollection importedFsIndexCollection;

  // fully resolved (imports) and merged type priorities

  // resolve with mergeDelegateAnalysisEngineTypePriorities

  // (This works also for primitives)

  // This collects all the type priority lists into one list, after

  // resolving imports.

  private TypePriorities mergedTypePriorities;

  private TypePriorities importedTypePriorities;

  // fully resolved (imports) ResourceManagerConfiguration

  // This collects all the External Resources and bindings into 2 list,

  // resolving imports. The resulting list may have

  // overridden bindings

  // unused external resources (not bound)

  private ResourceManagerConfiguration resolvedExternalResourcesAndBindings;

  // private ResourceManagerConfiguration importedExternalResourcesAndBindings;

  private FlowControllerDeclaration resolvedFlowControllerDeclaration;

  private CollectionReaderDescription collectionReaderDescription;

  private CasInitializerDescription casInitializerDescription;

  private CasConsumerDescription casConsumerDescription;

  private FlowControllerDescription flowControllerDescription;

  // values computed when first needed

  // all use common markStale()

  public DescriptorTCAS descriptorCAS;

  public AllTypes allTypes;

  public DefinedTypesWithSupers definedTypesWithSupers;

  // ****************************************

  // * Model parts not part of the descriptor

  // ****************************************

  private IFile file; // file being edited

  private IFile fileNeedingContext;

  // ***********************************************************

  // End of M O D E L

  // ***********************************************************

  /*

   * Each page is an instance of a particular class. These instances are created each time a new

   * instance of the editor opens.

   */

  protected int sourceIndex = -1;

  protected int overviewIndex = -1;

  private int aggregateIndex = -1;

  private int parameterIndex = -1;

  private int settingsIndex = -1;

  protected int typeIndex = -1;

  protected int capabilityIndex = -1;

  protected int indexesIndex = -1;

  protected int resourcesIndex = -1;

  protected OverviewPage overviewPage = null;

  private AggregatePage aggregatePage = null;

  private ParameterPage parameterPage = null;

  private SettingsPage settingsPage = null;

  protected TypePage typePage = null;

  protected CapabilityPage capabilityPage = null;

  protected IndexesPage indexesPage = null;

  protected ResourcesPage resourcesPage = null;

  protected XMLEditor sourceTextEditor;

  private boolean m_bIsInited = false;

  protected boolean isBadXML = true;

  public boolean sourceChanged = true;

  private boolean fileDirty; // can only be set dirty once inited

  private HashSet dirtyTypeNameHash; // for generating .java

  // type files upon saving (this has a problem if user edited xml

  // directly...)

  private int m_nSaveAsStatus = SAVE_AS_NOT_IN_PROGRESS;

  public static final int SAVE_AS_NOT_IN_PROGRESS = -1;

  public static final int SAVE_AS_STARTED = -2;

  public static final int SAVE_AS_CANCELLED = -3;

  public static final int SAVE_AS_CONFIRMED = -4;

  private boolean openingContext = false;

  private boolean isContextLoaded = false;

  public boolean getIsContextLoaded() {

    return isContextLoaded;

  }

  /**

   * Descriptor Types

   */

  private int descriptorType = 0;

  public int getDescriptorType() {

    return descriptorType;

  }

  public static final int DESCRIPTOR_AE = 1;

  public static final int DESCRIPTOR_TYPESYSTEM = 1 << 1;

  public static final int DESCRIPTOR_INDEX = 1 << 2;

  public static final int DESCRIPTOR_TYPEPRIORITY = 1 << 3;

  public static final int DESCRIPTOR_EXTRESANDBINDINGS = 1 << 4;

  public static final int DESCRIPTOR_COLLECTIONREADER = 1 << 5;

  public static final int DESCRIPTOR_CASINITIALIZER = 1 << 6;

  public static final int DESCRIPTOR_CASCONSUMER = 1 << 7;

  public static final int DESCRIPTOR_FLOWCONTROLLER = 1 << 8;

  public String descriptorTypeString(int pDescriptorType) {

    String r;

    switch (pDescriptorType) {

      case DESCRIPTOR_AE:

        r = Messages.getString("MultiPageEditor.0");break; //$NON-NLS-1$

      case DESCRIPTOR_TYPESYSTEM:

        r = Messages.getString("MultiPageEditor.1");break; //$NON-NLS-1$

      case DESCRIPTOR_INDEX:

        r = Messages.getString("MultiPageEditor.2");break; //$NON-NLS-1$

      case DESCRIPTOR_TYPEPRIORITY:

        r = Messages.getString("MultiPageEditor.3");break; //$NON-NLS-1$

      case DESCRIPTOR_EXTRESANDBINDINGS:

        r = Messages.getString("MultiPageEditor.4");break; //$NON-NLS-1$

      case DESCRIPTOR_COLLECTIONREADER:

        r = Messages.getString("MultiPageEditor.5");break; //$NON-NLS-1$

      case DESCRIPTOR_CASINITIALIZER:

        r = Messages.getString("MultiPageEditor.6");break; //$NON-NLS-1$

      case DESCRIPTOR_CASCONSUMER:

        r = Messages.getString("MultiPageEditor.7");break; //$NON-NLS-1$

      case DESCRIPTOR_FLOWCONTROLLER:

        r = "Flow Controller";

        break;

      default:

        throw new InternalErrorCDE(Messages.getString("MultiPageEditor.8")); //$NON-NLS-1$

    }

    return r + Messages.getString("MultiPageEditor.9"); //$NON-NLS-1$

  }

  public String descriptorTypeString() {

    return descriptorTypeString(descriptorType);

  }

  public boolean isAeDescriptor() {

    return 0 != (descriptorType & DESCRIPTOR_AE);

  }

  public boolean isTypeSystemDescriptor() {

    return 0 != (descriptorType & DESCRIPTOR_TYPESYSTEM);

  }

  public boolean isFsIndexCollection() {

    return 0 != (descriptorType & DESCRIPTOR_INDEX);

  }

  public boolean isTypePriorityDescriptor() {

    return 0 != (descriptorType & DESCRIPTOR_TYPEPRIORITY);

  }

  public boolean isExtResAndBindingsDescriptor() {

    return 0 != (descriptorType & DESCRIPTOR_EXTRESANDBINDINGS);

  }

  public boolean isCollectionReaderDescriptor() {

    return 0 != (descriptorType & DESCRIPTOR_COLLECTIONREADER);

  }

  public boolean isCasInitializerDescriptor() {

    return 0 != (descriptorType & DESCRIPTOR_CASINITIALIZER);

  }

  public boolean isCasConsumerDescriptor() {

    return 0 != (descriptorType & DESCRIPTOR_CASCONSUMER);

  }

  public boolean isFlowControllerDescriptor() {

    return 0 != (descriptorType & DESCRIPTOR_FLOWCONTROLLER);

  }

  public boolean isLocalProcessingDescriptor() {

    return 0 != (descriptorType & (DESCRIPTOR_AE | DESCRIPTOR_COLLECTIONREADER

            | DESCRIPTOR_CASINITIALIZER | DESCRIPTOR_CASCONSUMER | DESCRIPTOR_FLOWCONTROLLER));

  }

  public boolean isPrimitive() {

    return isLocalProcessingDescriptor() && aeDescription.isPrimitive();

  }

  public boolean isAggregate() {

    return isAeDescriptor() && (!aeDescription.isPrimitive());

  }

  private TypePriorities m_typePrioritiesBackup;

  private Color fadeColor;

  private boolean isRevertingIndex;

  protected boolean isPageChangeRecursion = false;

  public static final TypeDescription[] typeDescriptionArray0 = new TypeDescription[0];

 

  private List typeSystemsToMerge;

 

  private List typePrioritiesToMerge;

 

  private List fsIndexesToMerge;

 

  private Map failedRemotes = new TreeMap();

  private Set failedRemotesAlreadyKnown = new TreeSet();

  public MultiPageEditor() {

    super();

    // Model initialization

    fileDirty = false;

    dirtyTypeNameHash = new HashSet();

    descriptorCAS = new DescriptorTCAS(this);

    allTypes = new AllTypes(this);

    definedTypesWithSupers = new DefinedTypesWithSupers(this);

    // reasonable initial values

    aeDescription = UIMAFramework.getResourceSpecifierFactory().createAnalysisEngineDescription();

    typeSystemDescription = null;

    importedTypeSystemDescription = null;

    mergedTypeSystemDescription = null;

    mergedFsIndexCollection = aeDescription.getAnalysisEngineMetaData().getFsIndexCollection();

    resolvedExternalResourcesAndBindings = aeDescription.getResourceManagerConfiguration();

    resolvedFlowControllerDeclaration = aeDescription.getFlowControllerDeclaration();

    mergedTypePriorities = aeDescription.getAnalysisEngineMetaData().getTypePriorities();

  }

  /**

   * override the createToolkit method in FormEditor - to use a shared colors resource.

   *

   * This method is called by the FormEditor's createPages() method which will in turn call the

   * addPages method below. The toolkit ref is stored in the FormEditor object, and can be retrieved

   * by getToolkit().

   *

   */

  protected FormToolkit createToolkit(Display display) {

    return new FormToolkit(TAEConfiguratorPlugin.getDefault().getFormColors(display));

  }

  /*

   * Two forms of addPage - one for non-source-editors, and one for source-editor

   */

  protected int addPageAndSetTabTitle(HeaderPage page, String keyTabTitle) throws PartInitException {

    int pageIndex = addPage(page);

    // set the text on the tab used to select the page in the multipage editor

    setPageText(pageIndex, keyTabTitle);

    return pageIndex;

  }

  protected int addPageAndSetTabTitle(IEditorPart page, IEditorInput input, String keyTabTitle)

          throws PartInitException {

    int pageIndex = addPage(page, input);

    // set the text on the tab used to select the page in the multipage editor

    setPageText(pageIndex, keyTabTitle);

    return pageIndex;

  }

  /*

   * In general, 3 kinds of pages can be added. 1) an editor (IEditorPart, IEditorInput) 2) (lazy)

   * an IFormPage (extends IEditorPart) - has a managedForm, can wrap an editor 3) (lazy) a SWT

   * Control (Not Used)

   *

   * (non-Javadoc)

   *

   * @see org.eclipse.ui.forms.editor.FormEditor#addPages()

   */

  protected void addPages() {

    boolean allPages = isLocalProcessingDescriptor();

    try {

      overviewIndex = addPageAndSetTabTitle(overviewPage = new OverviewPage(this), Messages

              .getString("MultiPageEditor.overviewTab")); //$NON-NLS-1$

      if (allPages) {

        if (isAeDescriptor())

          aggregateIndex = addPageAndSetTabTitle(aggregatePage = new AggregatePage(this), Messages

                  .getString("MultiPageEditor.aggregateTab")); //$NON-NLS-1$

        parameterIndex = addPageAndSetTabTitle(parameterPage = new ParameterPage(this), Messages

                .getString("MultiPageEditor.parameterTab")); //$NON-NLS-1$

        settingsIndex = addPageAndSetTabTitle(settingsPage = new SettingsPage(this), Messages

                .getString("MultiPageEditor.settingsTab")); //$NON-NLS-1$

      }

      if (allPages || isTypeSystemDescriptor()) {

        typeIndex = addPageAndSetTabTitle(typePage = new TypePage(this), Messages

                .getString("MultiPageEditor.typeTab")); //$NON-NLS-1$

      }

      if (allPages) {

        capabilityIndex = addPageAndSetTabTitle(capabilityPage = new CapabilityPage(this), Messages

                .getString("MultiPageEditor.capabilityTab")); //$NON-NLS-1$

      }

      if (allPages || isTypePriorityDescriptor() || isFsIndexCollection()) {

        indexesIndex = addPageAndSetTabTitle(indexesPage = new IndexesPage(this), Messages

                .getString("MultiPageEditor.indexesTab")); //$NON-NLS-1$

      }

      if (allPages || isExtResAndBindingsDescriptor()) {

        resourcesIndex = addPageAndSetTabTitle(resourcesPage = new ResourcesPage(this), Messages

                .getString("MultiPageEditor.resourcesTab")); //$NON-NLS-1$

      }

      sourceIndex = addPageAndSetTabTitle(sourceTextEditor = new XMLEditor(this), getEditorInput(),

              Messages.getString("MultiPageEditor.sourceTab")); //$NON-NLS-1$

    } catch (PartInitException e) {

      e.printStackTrace(); // TODO fix this

    }

    if (isBadXML) {

      pageChange(sourceIndex);

    }

  }

  /**

   * @param monitor

   */

  public void jcasGen(IProgressMonitor monitor) {

    if (MultiPageEditorContributor.getAutoJCasGen()) {

      doJCasGenChkSrc(monitor);

    }

  }

  public void doJCasGenChkSrc(IProgressMonitor monitor) {

    if (isSourceFolderValid())

      doJCasGen(monitor);

  }

  public boolean isSourceFolderValid() {

    IResource folder = getPrimarySourceFolder();

    if (folder == null) {

      String msg = Messages.getString("MultiPageEditor.noSrcNoJCas"); //$NON-NLS-1$

      Utility.popMessage(Messages.getString("MultiPageEditor.noSrcDir"), msg, MessageDialog.ERROR); //$NON-NLS-1$

      return false;

    }

    return true;

  }

  private boolean syncSourceBeforeSavingToFile() {

    boolean modelOK = true;

    if (getCurrentPage() != sourceIndex) {

      validateIndexes();

      updateSourceFromModel();

    } else { // have to check if there are dirty types

      modelOK = validateSource();

    }

    if (modelOK && isLocalProcessingDescriptor()) {

      return isValidAE(aeDescription);

    }

    return modelOK;

  }

  public boolean isValidAE(AnalysisEngineDescription aAe) {

    AbstractSection.setVnsHostAndPort(aAe);

    // copy Ae into real descriptors if needed

    getTrueDescriptor();

    // use clones because validation modifies (imports get imported)

    if (isCollectionReaderDescriptor()) {

      CollectionReaderDescription collRdr = (CollectionReaderDescription) collectionReaderDescription

              .clone();

      try {

        collRdr.doFullValidation(createResourceManager());

      } catch (Throwable e) { // all these are Throwable to catch errors like

        // UnsupportedClassVersionError, which happens if the annotator

        // class is compiled for Java 5.0, but the CDE is running Java 1.4.2

        Utility

                .popMessage(

                        Messages.getString("MultiPageEditor.failedCollRdrValidation"), //$NON-NLS-1$

                        Messages.getString("MultiPageEditor.failedCollRdrValidationMsg") + "\n" + getMessagesToRootCause(e), //$NON-NLS-1$ //$NON-NLS-2$

                        MessageDialog.ERROR);

        return false;

      }

    } else if (isCasInitializerDescriptor()) {

      CasInitializerDescription casInit = (CasInitializerDescription) casInitializerDescription

              .clone();

      try {

        casInit.doFullValidation(createResourceManager());

      } catch (Throwable e) {

        Utility

                .popMessage(

                        Messages.getString("MultiPageEditor.failedCasInitValidation"), //$NON-NLS-1$

                        Messages.getString("MultiPageEditor.failedCasInitValidationMsg") + "\n" + getMessagesToRootCause(e), //$NON-NLS-1$ //$NON-NLS-2$

                        MessageDialog.ERROR);

        return false;

      }

    } else if (isCasConsumerDescriptor()) {

      CasConsumerDescription casCons = (CasConsumerDescription) casConsumerDescription.clone();

      try {

        casCons.doFullValidation(createResourceManager());

      } catch (Throwable e) {

        Utility

                .popMessage(

                        Messages.getString("MultiPageEditor.failedCasConsValidation"), //$NON-NLS-1$

                        Messages.getString("MultiPageEditor.failedCasConsValidationMsg") + "\n" + getMessagesToRootCause(e), //$NON-NLS-1$ //$NON-NLS-2$

                        MessageDialog.ERROR);

        return false;

      }

    } else if (isFlowControllerDescriptor()) {

      FlowControllerDescription fc = (FlowControllerDescription) flowControllerDescription.clone();

      try {

        fc.doFullValidation(createResourceManager());

      } catch (Throwable e) {

        Utility.popMessage("Error in Flow Controller Descriptor",

                "The Descriptor is invalid for the following reason:" + "\n"

                        + getMessagesToRootCause(e), MessageDialog.ERROR);

        return false;

      }

    } else {

      AnalysisEngineDescription ae = (AnalysisEngineDescription) aAe.clone();

      // speedup = replace typeSystem with resolved imports version

      if (ae.isPrimitive()) {

        TypeSystemDescription tsd = getMergedTypeSystemDescription();

        if (null != tsd) {

          tsd = (TypeSystemDescription) tsd.clone();

        }

        ae.getAnalysisEngineMetaData().setTypeSystem(tsd);

      }

      ae.getAnalysisEngineMetaData().setFsIndexCollection(getMergedFsIndexCollection());

      ae.getAnalysisEngineMetaData().setTypePriorities(getMergedTypePriorities());

      try {

        ae.doFullValidation(createResourceManager());

      } catch (Throwable e) {

        Utility

                .popMessage(

                        Messages.getString("MultiPageEditor.failedAeValidation"), //$NON-NLS-1$

                        Messages.getString("MultiPageEditor.failedAeValidationMsg") + "\n" + getMessagesToRootCause(e), //$NON-NLS-1$ //$NON-NLS-2$

                        MessageDialog.ERROR);

        return false;

      }

    }

    return true;

  }

  /**

   * Saves the multi-page editor's document.

   */

  public void doSave(IProgressMonitor monitor) {

    boolean modelOK = syncSourceBeforeSavingToFile();

    sourceTextEditor.doSave(monitor);

    finishSave(monitor, modelOK);

  }

  private void finishSave(IProgressMonitor monitor, boolean modelOK) {

    if (modelOK) {

      if (dirtyTypeNameHash.size() > 0)

        jcasGen(monitor);

      dirtyTypeNameHash.clear();

    }

    fileDirty = false;

    firePropertyChange(ISaveablePart.PROP_DIRTY);

  }

  /**

   * Saves the multi-page editor's document as another file. Updates this multi-page editor's input

   * to correspond to the nested editor's.

   *

   * This is not implemented correctly: filename isn't switched to new filename, etc.

   */

  public void doSaveAs() {