## Uses of Class
org.apache.torque.generator.source.SourceElement

- Packages that use SourceElement
  Package | Description
  --- | ---
  org.apache.torque.generator.source | This package contains the handling of source files.
  org.apache.torque.generator.source.jdbc | This package implements sources which read from jdbc.
  org.apache.torque.generator.source.stream | This package contains the handling of stream-based sources, such as file sources.
  org.apache.torque.generator.source.transform | This package contains the definition of source transformers and some implementations.
  org.apache.torque.generator.template.velocity | This package contains the handling of velocity outlets in the Torque generator.

- - ### Uses of SourceElement in org.apache.torque.generator.source

    Methods in org.apache.torque.generator.source that return SourceElement
    Modifier and Type | Method and Description
    --- | ---
    `SourceElement` | SourceElement.`copy()` Creates a deep copy of this RichSourceelementImpl object.
    `protected abstract SourceElement` | SourceImpl.`createRootElement()` Reads the root element and the whole untransformed source tree.
    `SourceElement` | SourceElement.`getChild(SourceElementName sourceElementName)` Returns the first child of this SourceElement which has the given name.
    `SourceElement` | SourceElement.`getChild(String name)` Returns the first child of this SourceElement which has the given name.
    `static SourceElement` | SourcePath.`getElement(SourceElement sourceElement, String path, boolean acceptEmpty)` Gets a single source element which can be reached from the start element by a given path.
    `SourceElement` | SourceElement.`getFirstChild()` Returns the first child of this source element.
    `SourceElement` | SourceElement.`getFollowingSourceElement(SourceElement parent)` Returns the following element after this element If this element has no parent, null is returned.
    `SourceElement` | SourceElement.`getLastChild()` Returns the last child of this source element.
    `SourceElement` | SourceElement.`getParent()` Returns the primary parent of this SourceElement.
    `SourceElement` | SourceElement.`getPrecedingSourceElement(SourceElement parent)` Returns the preceding element after this element.
    `SourceElement` | Source.`getRootElement()` Returns the root element of the source.
    `SourceElement` | SourceImpl.`getRootElement()`

    Methods in org.apache.torque.generator.source that return types with arguments of type SourceElement
    Modifier and Type | Method and Description
    --- | ---
    `List<SourceElement>` | SourceElement.`getChildren()` Returns all children of this SourceElement.
    `List<SourceElement>` | SourceElement.`getChildren(SourceElementName sourceElementName)` Returns all children of this SourceElement which have the given name.
    `List<SourceElement>` | SourceElement.`getChildren(String name)` Returns all children of this SourceElement which have the given name.
    `static List<SourceElement>` | SourcePath.`getElements(SourceElement sourceElement, String path)` Gets the elements which can be reached from the start element by a given path.
    `static List<SourceElement>` | SourcePath.`getElementsFromRoot(SourceElement rootElement, String path)` Gets the elements which can be reached from the root element by a given path.
    `static List<SourceElement>` | SourcePath.`getFollowing(SourceElement sourceElement, String name)` Returns all the following elements in the child list of the default parent which appear after this element with the given name.
    `List<SourceElement>` | SourceElement.`getFollowing(String name)` Returns all the following elements after this element with the given name.
    `List<SourceElement>` | SourceElement.`getParents()` Returns the list of parents of this SourceElement.
    `static List<SourceElement>` | SourcePath.`getPreceding(SourceElement sourceElement, String name)` Returns all the preceding elements in the child list of the default parent which appear before this element with the given name.
    `List<SourceElement>` | SourceElement.`getPreceding(String name)` Returns all the preceding elements before this element with the given name.
    `protected static ListIterator<SourceElement>` | SourcePath.`getSiblingIteratorPositionedOnSelf(SourceElement sourceElement, SourceElement parent)` Returns a ListIterator of the siblings of the input source element.

    Methods in org.apache.torque.generator.source with parameters of type SourceElement
    Modifier and Type | Method and Description
    --- | ---
    `static SourceElement` | SourcePath.`getElement(SourceElement sourceElement, String path, boolean acceptEmpty)` Gets a single source element which can be reached from the start element by a given path.
    `static List<SourceElement>` | SourcePath.`getElements(SourceElement sourceElement, String path)` Gets the elements which can be reached from the start element by a given path.
    `static List<SourceElement>` | SourcePath.`getElementsFromRoot(SourceElement rootElement, String path)` Gets the elements which can be reached from the root element by a given path.
    `static List<SourceElement>` | SourcePath.`getFollowing(SourceElement sourceElement, String name)` Returns all the following elements in the child list of the default parent which appear after this element with the given name.
    `SourceElement` | SourceElement.`getFollowingSourceElement(SourceElement parent)` Returns the following element after this element If this element has no parent, null is returned.
    `static Object` | SourcePath.`getObject(SourceElement root, String pathToBase, SourceElement sourceElement, String path, boolean acceptEmpty)` Gets a single source element which can be reached from the start element by a given path.
    `static String` | SourcePath.`getPathAsString(SourceElement sourceElement)` Returns the path from the root element to the source element.
    `static List<SourceElement>` | SourcePath.`getPreceding(SourceElement sourceElement, String name)` Returns all the preceding elements in the child list of the default parent which appear before this element with the given name.
    `SourceElement` | SourceElement.`getPrecedingSourceElement(SourceElement parent)` Returns the preceding element after this element.
    `protected static ListIterator<SourceElement>` | SourcePath.`getSiblingIteratorPositionedOnSelf(SourceElement sourceElement, SourceElement parent)` Returns a ListIterator of the siblings of the input source element.
    `boolean` | SourceElement.`graphEquals(SourceElement toCompare)` Checks whether the source element graph of this sourceElement, and its position therein, equals the source element graph and the position of the provided SourceElement.
    `static boolean` | SourcePath.`hasChild(SourceElement sourceElement, String name)` Returns whether children with the given name exist.
    `static boolean` | SourcePath.`hasFollowing(SourceElement sourceElement)` Returns whether a following element exists as a child of the parent of this element.
    `static boolean` | SourcePath.`hasFollowingSibling(SourceElement sourceElement)` Returns whether a following element exists as a child of the parent of this element, which has the same name as this source element.
    `static boolean` | SourcePath.`hasPreceding(SourceElement sourceElement)` Returns whether an preceding exists as a child of the parent of this element.
    `static boolean` | SourcePath.`hasPrecedingSibling(SourceElement sourceElement)` Returns whether an preceding exists as a child of the parent of this element, which has the same name as this source element.
    `static boolean` | SourceElementNodePointer.`testSourceElement(SourceElement sourceElement, org.apache.commons.jxpath.ri.compiler.NodeTest test)` Test a Node.

    Constructors in org.apache.torque.generator.source with parameters of type SourceElement
    Constructor and Description
    `SourceElementAttributePointer(org.apache.commons.jxpath.ri.model.NodePointer parent, SourceElement sourceElement, String name)` Constructor.
    `SourceElementNodePointer(org.apache.commons.jxpath.ri.model.NodePointer parent, SourceElement sourceElement)`
    `SourceElementNodePointer(SourceElement sourceElement, Locale locale)`

  - ### Uses of SourceElement in org.apache.torque.generator.source.jdbc

    Methods in org.apache.torque.generator.source.jdbc that return SourceElement
    Modifier and Type | Method and Description
    --- | ---
    `protected SourceElement` | JdbcMetadataSource.`createRootElement()`

  - ### Uses of SourceElement in org.apache.torque.generator.source.stream

    Methods in org.apache.torque.generator.source.stream that return SourceElement
    Modifier and Type | Method and Description
    --- | ---
    `SourceElement` | CombinedFileSource.`createRootElement()` Reads and parses the input file and creates the element tree from it.
    `SourceElement` | FileSource.`createRootElement()` Reads and parses the input file and creates the element tree from it.
    `SourceElement` | XmlSourceSaxHandler.`getRoot()` Returns the root element of the tree.
    `SourceElement` | PropertiesSourceFormat.`parse(InputStream inputStream, ControllerState controllerState)` Parses a Stream in Properties format and returns the root element of the created element tree.
    `SourceElement` | StreamSourceFormat.`parse(InputStream inputStream, ControllerState controllerState)` Parses a source file and returns its root element.
    `SourceElement` | XmlSourceFormat.`parse(InputStream xmlStream, ControllerState controllerState)` Parses a stream containing xml data and creates a source element hierarchy from it.

    Methods in org.apache.torque.generator.source.stream with parameters of type SourceElement
    Modifier and Type | Method and Description
    --- | ---
    `String` | SourceToXml.`toXml(SourceElement rootElement, boolean createIdAttributes)` Renders a source element and its children as XML.

  - ### Uses of SourceElement in org.apache.torque.generator.source.transform

    Methods in org.apache.torque.generator.source.transform that return SourceElement
    Modifier and Type | Method and Description
    --- | ---
    `SourceElement` | BeanPropertyMethodNameTransformer.`transform(Object rootObject, ControllerState controllerState)` Fills the target attribute according to the settings.
    `SourceElement` | CopyAttributeTransformer.`transform(Object rootObject, ControllerState controllerState)` Fills the target attribute according to the settings.
    `SourceElement` | GetterSetterNameTransformer.`transform(Object rootObject, ControllerState controllerState)` Fills the target attributes according to the settings.
    `SourceElement` | LoadAdditionalSourceTransformer.`transform(Object rootObject, ControllerState controllerState)` Loads the additional source into the current source graph.

  - ### Uses of SourceElement in org.apache.torque.generator.template.velocity

    Methods in org.apache.torque.generator.template.velocity that return SourceElement
    Modifier and Type | Method and Description
    --- | ---
    `SourceElement` | TorqueGenVelocity.`getChild(String name)` Returns the first child of the current source element with the given name.
    `SourceElement` | TorqueGenVelocity.`getParent()` Returns the parent of the current source element.
    `SourceElement` | TorqueGenVelocity.`getSourceElement()` Returns the current source element, if it is a SourceElement.

    Methods in org.apache.torque.generator.template.velocity that return types with arguments of type SourceElement
    Modifier and Type | Method and Description
    --- | ---
    `List<SourceElement>` | TorqueGenVelocity.`getChildren()` Returns all children of the current source element.
    `List<SourceElement>` | TorqueGenVelocity.`getChildren(String name)` Returns the children of the current source element with a certain name.

Copyright © 2000–2020 The Apache Software Foundation. All rights reserved.