org.xmlcml.cml.map.Indexable Maven / Gradle / Ivy

Go to download
/**
 *    Copyright 2011 Peter Murray-Rust et. al.
 *
 *    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.xmlcml.cml.map;


/**
 * catalogable object
 * retrievable from a catalog.
 * still being worked out
 * @author Peter Murray-Rust
 * @version 5.0
 * 
 */
public interface Indexable {
//	public enum Type {
//	/** fragment */
//	FRAGMENT(ICMLFragment.TAGX),
//	/** molecule */
//	MOLECULE(ICMLMolecule.TAGX);
//	/** peak */
//	PEAK(ICMLPeak.TAGX);
//		public String value;
//		private Type(String s) {
//			this.value = s;
//		}
//	}
	
	/** ensure integrity of list and children.
	 * @return class of parent
	 */
	Class getIndexableListClass();

	/** get id.
	 * @return id
	 */
	String getId();

	/** get ref.
	 * @return ref
	 */
	String getRef();
}