SchemaInterfaceI (MyTISM API Documentation)

All Known Implementing Classes:

SchemaInterface
```
public interface SchemaInterfaceI
```
Represents a schema interface definition.
This class encapsulates information about an interface defined within the schema XML document. It holds the interface name, its attributes, and the source XML element that defines the interface. It provides methods for performing validation and checks on the interface definition.
The <Interface> element in the XML schema serves a specialized purpose, defining a collection of attributes that will be implicitly implemented by any <Entity> referencing it through an <implements> subnode.

This behavior diverges from the conventional notion of interfaces in programming languages such as Java, where interfaces typically outline method signatures that implementing classes must explicitly provide.

Behavior
- Implicit Implementation: When an <Entity> incorporates an <implements> subnode referencing an <Interface>, all attributes defined within that <Interface> are automatically integrated into the <Entity>. There is no requirement to explicitly declare or define these attributes within the <Entity> itself as for now, to reduce "redundant" information in the schema files.
- Java Connection: This implicit implementation mechanism is intended to correspond to generated Java interface classes, that the corresponding classes representing the implementing Entity also do implement.
Example
```
 <Interface name="TestInterface">
   <attr name="AString"/>
   <attr name="AnInteger" type="Integer"/>
   <attr name="ABoolean" type="Boolean"/>
 </Interface>

 <Entity name="SomeEntity">
   <implements name="TestInterface"/>
 </Entity>
 
```
In this illustration, SomeEntity will inherently possess the attributes AString, AnInteger and ABoolean as part of its definition, even though they are not explicitly declared within the <Entity> itself.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ATT_NAME_CODE_CUSTOM`
`static java.lang.String`	`ATT_NAME_NAME`
`static java.lang.String`	`CUSTOM_CODE_BASE_NAME`
`static java.lang.String`	`EL_NAME_CODE`
`static java.lang.String`	`EL_NAME_EXTENDS`
`static java.lang.String`	`REQUIRED_NAME_SUFFIX`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`java.util.Collection<? extends BasicAttributeI>`	`getAllAttributes()`
`java.util.Collection<electric.xml.Element>`	`getAllXMLElements()` Returns a collection of XML elements representing the attributes defined in this interface, and all schema-defined super interfaces of this interface.
`java.util.Collection<? extends BasicAttributeI>`	`getAttributes()`
`java.util.Set<java.lang.String>`	`getExtends()` Returns the names of one or more parent interfaces as a set of fully qualified class names
`default java.lang.String`	`getFQClassName()`
`java.lang.String`	`getName()` Returns the name of this SchemaInterfaceI instance.
`java.lang.String`	`getPackageName()` Returns the name of the package this interface belongs into.
`SchemaI`	`getSchema()` Returns the schema this interface is a part of
`default java.lang.String`	`getSourceFilename()`
`java.util.Collection<electric.xml.Element>`	`getXMLElements()` Returns a collection of XML elements representing the attributes defined in this interface.
`boolean`	`hasCustomCode()` if true, we may expect a custom-written interface class to be present for the interface of this name, and the code generator will create a "basic" interface the custom interface may inherit from.
`default java.lang.String`	`parametersToString()` Generates a string representation of the parameters of this SchemaInterfaceI.

- Field Detail
  - REQUIRED_NAME_SUFFIX
```
static final java.lang.String REQUIRED_NAME_SUFFIX
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_NAME
```
static final java.lang.String ATT_NAME_NAME
```
    See Also:
    
    Constant Field Values
  - EL_NAME_EXTENDS
```
static final java.lang.String EL_NAME_EXTENDS
```
    See Also:
    
    Constant Field Values
  - EL_NAME_CODE
```
static final java.lang.String EL_NAME_CODE
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_CODE_CUSTOM
```
static final java.lang.String ATT_NAME_CODE_CUSTOM
```
    See Also:
    
    Constant Field Values
  - CUSTOM_CODE_BASE_NAME
```
static final java.lang.String CUSTOM_CODE_BASE_NAME
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getName
```
java.lang.String getName()
```
    Returns the name of this SchemaInterfaceI instance.
    Can also be used for querying objects in OQL queries that implement this interface.
    
    Returns:
    
    The name of this SchemaInterfaceI instance.
  - getSchema
```
SchemaI getSchema()
```
    Returns the schema this interface is a part of
    
    Returns:
    
    the schema this interface is a part of
  - getExtends
```
java.util.Set<java.lang.String> getExtends()
```
    Returns the names of one or more parent interfaces as a set of fully qualified class names
    
    Returns:
    
    the name names of one or more parent interface, if any.
  - hasCustomCode
```
boolean hasCustomCode()
```
    if true, we may expect a custom-written interface class to be present for the interface of this name, and the code generator will create a "basic" interface the custom interface may inherit from.
  - getPackageName
```
java.lang.String getPackageName()
```
    Returns the name of the package this interface belongs into. Relevant for code generation.
    
    Returns:
    
    The name of the package this interface belongs to.
  - getFQClassName
```
default java.lang.String getFQClassName()
```
  - getSourceFilename
```
default java.lang.String getSourceFilename()
```
    Returns:
    
    the name to use for the auto-generated source code file
  - getXMLElements
```
java.util.Collection<electric.xml.Element> getXMLElements()
```
    Returns a collection of XML elements representing the attributes defined in this interface.
    
    Returns:
    
    A `Collection` of `Element` objects, each representing an attribute definition.
  - getAllXMLElements
```
java.util.Collection<electric.xml.Element> getAllXMLElements()
```
    Returns a collection of XML elements representing the attributes defined in this interface, and all schema-defined super interfaces of this interface.
    
    Returns:
    
    A `Collection` of `Element` objects, each representing an attribute definition or an inherited attribute definition.
  - getAttributes
```
java.util.Collection<? extends BasicAttributeI> getAttributes()
```
    Returns:
    
    all attributes defined as part of this interface
  - getAllAttributes
```
java.util.Collection<? extends BasicAttributeI> getAllAttributes()
```
    Returns:
    
    all attributes defined as part of this interface or its super interfaces
  - parametersToString
```
default java.lang.String parametersToString()
```
    Generates a string representation of the parameters of this SchemaInterfaceI.
    The returned string is in the format "[name=value]", where "value" is the result of de.ipcon.tools.TypeDistiller#outVal(String) applied to the interface's name.
    
    Returns:
    
    A string representation of the parameters.

Interface SchemaInterfaceI

Behavior

Example

Field Summary

Method Summary

Field Detail

REQUIRED_NAME_SUFFIX

ATT_NAME_NAME

EL_NAME_EXTENDS

EL_NAME_CODE

ATT_NAME_CODE_CUSTOM

CUSTOM_CODE_BASE_NAME

Method Detail

getName

getSchema

getExtends

hasCustomCode

getPackageName

getFQClassName

getSourceFilename

getXMLElements

getAllXMLElements

getAttributes

getAllAttributes

parametersToString