com.edustructures.sifworks.infra
Class SIF_Select

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.infra.SIF_Select

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SIF_Select
extends SIFElement

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_Select()
Constructor

SIF_Select(java.lang.Boolean distinct, java.lang.String rowCount, SIFSelectElement sifElement)
Constructor that accepts values for all mandatory fields

Method Summary

void	addSIF_Element(SIFSelectElement value) Adds a new <SIF_Element> child element.
void	addSIF_Element(java.lang.String alias, Topics objectName, java.lang.String value) Adds a new <SIF_Element> repeatable element.
java.lang.Boolean	getDistinct() Gets the value of the Distinct attribute.
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	getRowCount() Gets the value of the RowCount attribute.
SIFSelectElement	getSIF_Element(java.lang.String alias, Topics objectName) Gets a SIFSelectElement object instance.
SIFSelectElement[]	getSIF_Elements() Gets all SIFSelectElement object instances.
void	removeSIF_Element(java.lang.String alias, Topics objectName) Removes a SIFSelectElement object instance.
void	setDistinct(java.lang.Boolean value) Sets the value of the Distinct attribute.
void	setRowCount(java.lang.String value) Sets the value of the RowCount attribute.
void	setSIF_Elements(SIFSelectElement[] sif_elements) Sets an array of SIFSelectElement objects.

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_Select

public SIF_Select()

Constructor

SIF_Select

public SIF_Select(java.lang.Boolean distinct,
                  java.lang.String rowCount,
                  SIFSelectElement sifElement)

Constructor that accepts values for all mandatory fields

Parameters:

distinct - Specifies whether query results should return all rows (false) or just distinct ones (true). Rows are distinct if at least one column differs between them.

rowCount - The maximum number of rows to return. If All, return all rows, otherwise return the top rows up to the maximum row count indicated.

sifElement -

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

getDistinct

public java.lang.Boolean getDistinct()

Gets the value of the Distinct attribute.

The SIF specification defines the meaning of this attribute as: "Specifies whether query results should return all rows (false) or just distinct ones (true). Rows are distinct if at least one column differs between them."

Returns:

The Distinct attribute of this object.

Since:

2.0

setDistinct

public void setDistinct(java.lang.Boolean value)

Sets the value of the Distinct attribute.

The SIF specification defines the meaning of this attribute as: "Specifies whether query results should return all rows (false) or just distinct ones (true). Rows are distinct if at least one column differs between them."

Parameters:

value - A Boolean object

Since:

2.0

getRowCount

public java.lang.String getRowCount()

Gets the value of the RowCount attribute.

The SIF specification defines the meaning of this attribute as: "The maximum number of rows to return. If All, return all rows, otherwise return the top rows up to the maximum row count indicated."

Returns:

The RowCount attribute of this object.

Since:

2.0

setRowCount

public void setRowCount(java.lang.String value)

Sets the value of the RowCount attribute.

The SIF specification defines the meaning of this attribute as: "The maximum number of rows to return. If All, return all rows, otherwise return the top rows up to the maximum row count indicated."

Parameters:

value - A String object

Since:

2.0

addSIF_Element

public void addSIF_Element(SIFSelectElement value)

Adds a new <SIF_Element> child element.

Parameters:

value - A SIFSelectElement object

Since:

2.0

addSIF_Element

public void addSIF_Element(java.lang.String alias,
                           Topics objectName,
                           java.lang.String value)

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

Parameters:

alias -

objectName -

value - Gets or sets the content value of the <SIFSelectElement> element

Since:

2.0

removeSIF_Element

public void removeSIF_Element(java.lang.String alias,
                              Topics objectName)

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

Parameters:

alias - Identifies the SIFSelectElement object to remove by its Alias value

objectName - Identifies the SIFSelectElement object to remove by its ObjectName value

Since:

2.0

getSIF_Element

public SIFSelectElement getSIF_Element(java.lang.String alias,
                                       Topics objectName)

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

Parameters:

alias - Identifies the SIFSelectElement object to return by its "Alias" attribute value

objectName - Identifies the SIFSelectElement object to return by its "ObjectName" attribute value

Returns:

A SIFSelectElement object

Since:

2.0

getSIF_Elements

public SIFSelectElement[] getSIF_Elements()

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

Returns:

An array of SIFSelectElement objects

Since:

2.0

setSIF_Elements

public void setSIF_Elements(SIFSelectElement[] sif_elements)

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

Since:

2.0