com.edustructures.sifworks.infra
Class SIF_Join

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.infra.SIF_Join

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SIF_Join
extends SIFKeyedElement

Since:

2.0

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

SIF_Join()
Constructor

SIF_Join(SIFJoinType type, SIF_JoinOn sifJoinOn)
Constructor that accepts values for all mandatory fields

Method Summary

void	addSIF_JoinOn(SIF_JoinOn value) Adds a new <SIF_JoinOn> child element.
void	addSIF_JoinOn(SIF_LeftElement sifLeftElement, SIF_RightElement sifRightElement) Adds a new <SIF_JoinOn> repeatable element.
java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
SIF_JoinOn	getSIF_JoinOn(SIF_LeftElement sifLeftElement, SIF_RightElement sifRightElement) Gets a SIF_JoinOn object instance.
SIF_JoinOn[]	getSIF_JoinOns() Gets all SIF_JoinOn object instances.
java.lang.String	getType() Gets the value of the Type attribute.
void	removeSIF_JoinOn(SIF_LeftElement sifLeftElement, SIF_RightElement sifRightElement) Removes a SIF_JoinOn object instance.
void	setSIF_JoinOns(SIF_JoinOn[] sif_joinons) Sets an array of SIF_JoinOn objects.
void	setType(SIFJoinType value) Sets the value of the Type attribute.
void	setType(java.lang.String value) Sets the value of the Type attribute as a String.

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getSIFVersion, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, setSIFVersion, setTextValue, setXmlId, tag

Methods inherited from class com.edustructures.sifworks.Element

compareTo, getElementDef, getParent, getRoot, isChanged, isDoNotEncode, isEmpty, setChanged, setDoNotEncode, setElementDef, setEmpty, setParent, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SIF_Join

public SIF_Join()

Constructor

SIF_Join

public SIF_Join(SIFJoinType type,
                SIF_JoinOn sifJoinOn)

Constructor that accepts values for all mandatory fields

Parameters:

type -

sifJoinOn -

Method Detail

getKey

public java.lang.String getKey()

Gets the key of this object

Overrides:

getKey in class SIFElement

Returns:

The value of the object's Mandatory or Required attribute. If an object has more than one such attribute, the key is a period- delimited concatenation of the attribute values in sequential order

getKeyFields

public ElementDef[] getKeyFields()

Gets the metadata fields that make up the key of this object

Returns:

an array of metadata fields that make up the object's key

getType

public java.lang.String getType()

Gets the value of the Type attribute.

Returns:

The Type attribute of this object.

Since:

2.0

setType

public void setType(SIFJoinType value)

Sets the value of the Type attribute.

Parameters:

value - A constant defined by the SIFJoinType class

Since:

2.0

setType

public void setType(java.lang.String value)

Sets the value of the Type attribute as a String.

Parameters:

value - The value as a String

Since:

2.0

addSIF_JoinOn

public void addSIF_JoinOn(SIF_JoinOn value)

Adds a new <SIF_JoinOn> child element.

Parameters:

value - A SIF_JoinOn object

Since:

2.0

addSIF_JoinOn

public void addSIF_JoinOn(SIF_LeftElement sifLeftElement,
                          SIF_RightElement sifRightElement)

Adds a new <SIF_JoinOn> repeatable element. This form of setSIF_JoinOn is provided as a convenience method that is functionally equivalent to the version of setSIF_JoinOn that accepts a single SIF_JoinOn object.

Parameters:

sifLeftElement -

sifRightElement -

Since:

2.0

removeSIF_JoinOn

public void removeSIF_JoinOn(SIF_LeftElement sifLeftElement,
                             SIF_RightElement sifRightElement)

Removes a SIF_JoinOn object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

sifLeftElement - Identifies the SIF_JoinOn object to remove by its SIF_LeftElement value

sifRightElement - Identifies the SIF_JoinOn object to remove by its SIF_RightElement value

Since:

2.0

getSIF_JoinOn

public SIF_JoinOn getSIF_JoinOn(SIF_LeftElement sifLeftElement,
                                SIF_RightElement sifRightElement)

Gets a SIF_JoinOn object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

sifLeftElement - Identifies the SIF_JoinOn object to return by its "SIF_LeftElement" attribute value

sifRightElement - Identifies the SIF_JoinOn object to return by its "SIF_RightElement" attribute value

Returns:

A SIF_JoinOn object

Since:

2.0

getSIF_JoinOns

public SIF_JoinOn[] getSIF_JoinOns()

Gets all SIF_JoinOn object instances. More than one instance can be defined for this object because it is a repeatable field element.

Returns:

An array of SIF_JoinOn objects

Since:

2.0

setSIF_JoinOns

public void setSIF_JoinOns(SIF_JoinOn[] sif_joinons)

Sets an array of SIF_JoinOn objects. All existing SIF_JoinOn instances are removed and replaced with this list. Calling this method with the parameter value set to null removes all SIF_JoinOns.

Since:

2.0