Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.torque.generator.source
Interface Source

All Known Implementing Classes:
  CombinedFileSource, FileSource, JdbcMetadataSource, SourceImpl

    public interface Source

An entity which serves as an input for the generation process.

Method Summary
`String` | `getDescription()` Gets a description of this source for debugging purposes.
`SourceElement` | `getRootElement()` Returns the root element of the source.
`File` | `getSourceFile()` Returns the source file, if it exists.

Method Detail

### getRootElement

    SourceElement getRootElement()
                                 throws SourceException

  Returns the root element of the source.

  Returns:
    the root element of the source, not null.
  Throws:
    `SourceException` - if the source cannot be constructed.

### getDescription

    String getDescription()

  Gets a description of this source for debugging purposes.

  Returns:
    the description, which should make it possible to identify the currently processed output.

### getSourceFile

    File getSourceFile()

  Returns the source file, if it exists.

  Returns:
    the source file, or null if the source is not read from a file.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2013 The Apache Software Foundation. All Rights Reserved.