RepositoryMeta.java

/*! ******************************************************************************
 *
 * Pentaho Data Integration
 *
 * Copyright (C) 2002-2016 by Pentaho : http://www.pentaho.com
 *
 *******************************************************************************
 *
 * Licensed 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.pentaho.di.repository;

import java.util.List;
import java.util.Map;

import org.json.simple.JSONObject;
import org.pentaho.di.core.database.DatabaseMeta;
import org.pentaho.di.core.exception.KettleException;
import org.w3c.dom.Node;

public interface RepositoryMeta {

  public static final String XML_TAG = "repository";

  public abstract String getDialogClassName();

  public abstract String getRevisionBrowserDialogClassName();

  public abstract void loadXML( Node repnode, List<DatabaseMeta> databases ) throws KettleException;

  public abstract String getXML();

  /**
   * @return the id
   */
  public abstract String getId();

  /**
   * @param id
   *          the id to set
   */
  public abstract void setId( String id );

  /**
   * @return the name
   */
  public abstract String getName();

  /**
   * @param name
   *          the name to set
   */
  public abstract void setName( String name );

  /**
   * @return the description
   */
  public abstract String getDescription();

  /**
   * @param description
   *          the description to set
   */
  public abstract void setDescription( String description );

  /**
   * @return the isDefault
   */
  public abstract Boolean isDefault();

  /**
   * @param isDefault
   *          the isDefault to set
   */
  public abstract void setDefault( Boolean isDefault );

  /**
   * Describes the capabilities of the repository
   *
   * @return The repository capabilities object
   */
  public RepositoryCapabilities getRepositoryCapabilities();

  public RepositoryMeta clone();

  public abstract void populate( Map<String, Object> properties, RepositoriesMeta repositoriesMeta );

  public abstract JSONObject toJSONObject();

}