View Javadoc

1   //-------------------------------------------------------------------------
2   // FILE:    XmlToNativeIfc.java
3   // PACKAGE: org.astrogrid.ace.utils
4   //
5   // DATE       AUTHOR    NOTES
6   // ----       ------    -----
7   // 14/10/02   KEA       Initial prototype
8   //-------------------------------------------------------------------------
9   
10  
11  package org.astrogrid.ace.utils;
12  
13  import java.io.Reader;
14  import java.io.Writer;
15  
16  
17  /***
18   * <p>Interface class for conversions from Ace XML to SExtractor 
19   *  native parameter file format.
20   *
21   * <p>Intended to provide a generic interface for which particular
22   * implementations (DOM-parser-based, XSLT-based etc) can be supplied
23   * as required.
24   *
25   * <p>See Translator.java for a usage example, and Tester.java  
26   * for a run-time test harness.
27   * 
28   *
29   * @see org.astrogrid.ace.utils.XmlToNativeDomImpl
30   * @see org.astrogrid.ace.utils.Translator
31   * @see org.astrogrid.ace.utils.Tester
32   *
33   * @author Kona Andrews,
34   * <a href="mailto:kea@ast.cam.ac.uk">kea@ast.cam.ac.uk</a>
35   * @version 1.0
36   *
37   *
38   * (c) Copyright Astrogrid 2002; all rights reserved.
39   * See http://www.astrogrid.org/code_licence.html for terms of usage.
40   */
41  public interface XmlToNativeIfc
42  {
43  	/***
44  	 * Converts Ace XML input to SExtractor output (configuration
45  	 * file *.sex and catalog parameter file *.param).
46  	 * 
47  	 * @param xmlIn  A (pre-initialised) reader for the input XML
48  	 *
49  	 * @param configOutWriter  A (pre-initialised) writer for the output 
50  	 *     SExtractor *.sex * file.
51  	 *
52  	 * @param catalogOutWriter  A (pre-initialised) writer for the output 
53  	 *     SExtractor *.param file.
54  	 */
55  	public void makeNative(Reader XmlIn, Writer configOutWriter,
56  									Writer catalogOutWriter) throws Exception;
57  }
58  //-------------------------------------------------------------------------