de.ipcon.schema

Class SchemaInterface

java.lang.Object

de.ipcon.schema.SchemaInterface

All Implemented Interfaces:

SchemaInterfaceI

public class SchemaInterface
extends java.lang.Object
implements SchemaInterfaceI

A (or rather "the") concrete implementation of `SchemaInterfaceI`, which represents a schema interface definition.

This class stores the details of a parsed schema interface, including its name, attributes, and the corresponding XML element. It offers functionality to validate the interface definition and access its components.

Field Summary

Fields inherited from interface de.ipcon.schema.SchemaInterfaceI

ATT_NAME_CODE_CUSTOM, ATT_NAME_NAME, CUSTOM_CODE_BASE_NAME, EL_NAME_CODE, EL_NAME_EXTENDS, REQUIRED_NAME_SUFFIX

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
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()
electric.xml.Element	getEl() Returns the XML element that defines this schema interface.
java.util.Set<java.lang.String>	getExtends() Returns the names of one or more parent interfaces as a set of fully qualified class names
java.lang.String	getName() Returns the name of this SchemaInterfaceI instance.
electric.xml.Element	getOriginalEl() Returns a copy of the original XML element that defined this schema interface.
java.lang.String	getPackageName() Returns the name of the package this interface belongs into.
SchemaI	getSchema() Returns the schema to which this interface belongs.
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.
int	hashCode()
void	resolveCrossReferences() attempts to resolve cross references to other entities or interfaces from this interface via the schema.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.ipcon.schema.SchemaInterfaceI

getFQClassName, getSourceFilename, parametersToString

Method Detail

resolveCrossReferences

public void resolveCrossReferences()

attempts to resolve cross references to other entities or interfaces from this interface via the schema. For this method to work properly, the entire schema must have been read entirely at least once.

getEl

public electric.xml.Element getEl()

Returns the XML element that defines this schema interface.

Returns:

The `Element` representing the interface definition in the XML schema.

getOriginalEl

public electric.xml.Element getOriginalEl()

Returns a copy of the original XML element that defined this schema interface.

Returns:

A copy of the original `Element` representing the interface definition in the XML schema.

getSchema

public SchemaI getSchema()

Returns the schema to which this interface belongs.

Specified by:

getSchema in interface SchemaInterfaceI

Returns:

The `SchemaI` instance associated with this interface.

getExtends

public java.util.Set<java.lang.String> getExtends()

Description copied from interface: SchemaInterfaceI

Returns the names of one or more parent interfaces as a set of fully qualified class names

Specified by:

getExtends in interface SchemaInterfaceI

Returns:

the name names of one or more parent interface, if any.

hasCustomCode

public boolean hasCustomCode()

Description copied from interface: SchemaInterfaceI

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.

Specified by:

hasCustomCode in interface SchemaInterfaceI

getName

public java.lang.String getName()

Description copied from interface: SchemaInterfaceI

Returns the name of this SchemaInterfaceI instance.

Can also be used for querying objects in OQL queries that implement this interface.

Specified by:

getName in interface SchemaInterfaceI

Returns:

The name of this SchemaInterfaceI instance.

getPackageName

public java.lang.String getPackageName()

Description copied from interface: SchemaInterfaceI

Returns the name of the package this interface belongs into. Relevant for code generation.

Specified by:

getPackageName in interface SchemaInterfaceI

Returns:

The name of the package this interface belongs to.

getXMLElements

public java.util.Collection<electric.xml.Element> getXMLElements()

Description copied from interface: SchemaInterfaceI

Returns a collection of XML elements representing the attributes defined in this interface.

Specified by:

getXMLElements in interface SchemaInterfaceI

Returns:

A `Collection` of `Element` objects, each representing an attribute definition.

getAllXMLElements

public java.util.Collection<electric.xml.Element> getAllXMLElements()

Description copied from interface: SchemaInterfaceI

Returns a collection of XML elements representing the attributes defined in this interface, and all schema-defined super interfaces of this interface.

Specified by:

getAllXMLElements in interface SchemaInterfaceI

Returns:

A `Collection` of `Element` objects, each representing an attribute definition or an inherited attribute definition.

getAttributes

public java.util.Collection<? extends BasicAttributeI> getAttributes()

Specified by:

getAttributes in interface SchemaInterfaceI

Returns:

all attributes defined as part of this interface

getAllAttributes

public java.util.Collection<? extends BasicAttributeI> getAllAttributes()

Specified by:

getAllAttributes in interface SchemaInterfaceI

Returns:

all attributes defined as part of this interface or its super interfaces

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object