com.edustructures.sifworks.infra
Class SIF_From

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SIF_From
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_From()
Constructor

SIF_From(Topics objectName, SIF_Object sifObject)
Constructor that accepts values for all mandatory fields

Method Summary

void	addSIF_Join(SIF_Join value) Adds a new <SIF_Join> child element.
void	addSIF_Join(SIFJoinType type, SIF_JoinOn sifJoinOn) Adds a new <SIF_Join> 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
java.lang.String	getObjectName() Gets the value of the ObjectName attribute.
SIF_Join	getSIF_Join(SIFJoinType type) Gets a SIF_Join object instance.
SIF_Join[]	getSIF_Joins() Gets all SIF_Join object instances.
SIF_Object	getSIF_Object() Gets the value of the <SIF_Object> element.
void	removeSIF_Join(SIFJoinType type) Removes a SIF_Join object instance.
void	removeSIF_Object() Removes the SIF_Object child element previously created by calling setSIF_Object
void	setObjectName(java.lang.String value) Sets the value of the ObjectName attribute as a String.
void	setObjectName(Topics value) Sets the value of the ObjectName attribute.
void	setSIF_Joins(SIF_Join[] sif_joins) Sets an array of SIF_Join objects.
void	setSIF_Object(SIF_Object value) Sets the value of the <SIF_Object> element.
void	setSIF_Object(java.lang.String objectName) Sets the value of the <SIF_Object> child element.

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_From

public SIF_From()

Constructor

SIF_From

public SIF_From(Topics objectName,
                SIF_Object sifObject)

Constructor that accepts values for all mandatory fields

Parameters:

objectName -

sifObject -

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

getObjectName

public java.lang.String getObjectName()

Gets the value of the ObjectName attribute.

Returns:

The ObjectName attribute of this object.

Since:

2.0

setObjectName

public void setObjectName(Topics value)

Sets the value of the ObjectName attribute.

Parameters:

value - A constant defined by the Topics class

Since:

2.0

setObjectName

public void setObjectName(java.lang.String value)

Sets the value of the ObjectName attribute as a String.

Parameters:

value - The value as a String

Since:

2.0

setSIF_Object

public void setSIF_Object(SIF_Object value)

Sets the value of the <SIF_Object> element.

Parameters:

value - A SIF_Object object

Since:

2.0

setSIF_Object

public void setSIF_Object(java.lang.String objectName)

Sets the value of the <SIF_Object> child element. This form of setSIF_Object is provided as a convenience method that is functionally equivalent to the version of setSIF_Object that accepts a single SIF_Object object.

Parameters:

objectName - The name of a SIF data object

Since:

2.0

getSIF_Object

public SIF_Object getSIF_Object()

Gets the value of the <SIF_Object> element.

Returns:

A SIF_Object object

Since:

2.0

removeSIF_Object

public void removeSIF_Object()

Removes the SIF_Object child element previously created by calling setSIF_Object

Since:

2.0

addSIF_Join

public void addSIF_Join(SIF_Join value)

Adds a new <SIF_Join> child element.

Parameters:

value - A SIF_Join object

Since:

2.0

addSIF_Join

public void addSIF_Join(SIFJoinType type,
                        SIF_JoinOn sifJoinOn)

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

Parameters:

type -

sifJoinOn -

Since:

2.0

removeSIF_Join

public void removeSIF_Join(SIFJoinType type)

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

Parameters:

type - Identifies the SIF_Join object to remove by its Type value

Since:

2.0

getSIF_Join

public SIF_Join getSIF_Join(SIFJoinType type)

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

Parameters:

type - Identifies the SIF_Join object to return by its "Type" attribute value

Returns:

A SIF_Join object

Since:

2.0

getSIF_Joins

public SIF_Join[] getSIF_Joins()

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

Returns:

An array of SIF_Join objects

Since:

2.0

setSIF_Joins

public void setSIF_Joins(SIF_Join[] sif_joins)

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

Since:

2.0