|
OBEROn SDK | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.oberon.ooql.sdk.OBBase com.oberon.ooql.sdk.AdminComponent com.oberon.ooql.sdk.FieldRange
public class FieldRange
Defines valid values/intervals (ranges) for Field
objects.
Field Summary | |
---|---|
static int |
CLOSED
Includes all values included in a interval; includes also both the margins |
static int |
EQUAL
Specifies a single value |
static int |
GREAT
Includes all values greater than a given value |
static int |
GREAT_EQUAL
Includes all values greater or equal of a given value |
static int |
LEFT_OPENED
Includes all values included in a interval; excludes the left margin |
static int |
LESS
Includes all values less than a given value |
static int |
LESS_EQUAL
Includes all values less or equal of a given value |
static int |
NOT_EQUAL
Exclude a single value |
static int |
OPENED
Includes all values included in a interval; excludes both the margins |
static int |
RIGHT_OPENED
Includes all values included in a interval; excludes the right margin |
Fields inherited from class com.oberon.ooql.sdk.AdminComponent |
---|
bsOptions |
Constructor Summary | |
---|---|
FieldRange()
|
|
FieldRange(int rangeType,
java.lang.String value)
Create a new simple range |
|
FieldRange(int rangeType,
java.lang.String leftValue,
java.lang.String rightValue)
Create a new interval range |
|
FieldRange(java.lang.String composedRange)
Create a new range using a composed string |
Method Summary | |
---|---|
boolean |
equals(FieldRange range)
Check if a given range is equal to this range |
void |
fromXML(org.jdom.Element rootElement)
Load the range from XML element tree |
java.lang.String |
getCreateCommand(boolean force)
[Inherited but not used] |
java.lang.String |
getLeftValue()
Return the left (low) or the reference value for simple ranges |
java.lang.String |
getProperty(java.lang.String propertyName,
java.util.Vector<java.lang.Object> filterArgs,
java.lang.String sToken,
Framework framework)
[inherited but NOT USED] |
int |
getRangeType()
Return the range type |
java.lang.String |
getRangeTypeAsString()
Return the range type as String |
java.lang.String |
getRightValue()
Return the right (high) value |
java.lang.String |
getSaveCommand(boolean force)
[Inherited but not used] |
java.util.Vector<?> |
getTargetNames(java.lang.String composedName,
java.util.Vector<java.lang.Object> filterArgs,
Framework framework)
[inherited but NOT USED] |
static int |
getTypeFromString(java.lang.String rangeType)
Convert the range type from a String to the internal value |
static int |
indexOf(java.util.Vector<FieldRange> ranges,
FieldRange searchRange)
Check if a range is included in a range Vector. |
boolean |
isInterval()
Check if the range is an interval range (otherwise it is a simple range) |
boolean |
isValidValue(java.lang.String value)
Check if a value is compatible with this range |
void |
setRange(int rangeType,
java.lang.String value)
Set a new simple range |
void |
setRange(int rangeType,
java.lang.String leftValue,
java.lang.String rightValue)
Set a new interval range |
java.lang.String |
toString()
Return the FieldRange as a single String |
java.lang.String |
toString(boolean isString)
Return the FieldRange as a single String |
org.jdom.Element |
toXML(boolean getImage,
boolean fullDump,
Framework framework)
Return the range as XML element tree |
org.jdom.Element |
toXML(Framework framework)
Return the range as XML element tree |
Methods inherited from class com.oberon.ooql.sdk.AdminComponent |
---|
checkChangeName, getAdminType, getCommonProperty, getCommonTargetNames, getCrtDate, getDescription, getEditBasicCommand, getImage, getImageData, getImageFile, getModDate, getModUser, getName, getOldName, hasImage, setCrtDate, setDescription, setImage, setImageData, setImageFile, setModDate, setModUser, setName, toCommonXML, toXML |
Methods inherited from class com.oberon.ooql.sdk.OBBase |
---|
addChange, addUniqueChange, ChangesFromXML, ChangesToXML, getChanges, getChangesAsString, getId, isLinked, removeChange, resetChanges, setId, setLinked |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int EQUAL
public static final int NOT_EQUAL
public static final int LESS
public static final int GREAT
public static final int LESS_EQUAL
public static final int GREAT_EQUAL
public static final int CLOSED
public static final int LEFT_OPENED
public static final int RIGHT_OPENED
public static final int OPENED
Constructor Detail |
---|
public FieldRange()
public FieldRange(int rangeType, java.lang.String leftValue, java.lang.String rightValue)
rangeType
- the interval type ( CLOSED
, LEFT_OPENED
, RIGHT_OPENED
, OPENED
)leftValue
- the left or low valuerightValue
- the right or high valuepublic FieldRange(int rangeType, java.lang.String value)
rangeType
- the range type ( EQUAL
, NOT_EQUAL
, LESS
, GREAT
, LESS_EQUAL
, GREAT_EQUAL
)value
- the reference valuepublic FieldRange(java.lang.String composedRange)
composedRange
- the range in format: <type>|<leftvalue>|<rightvalue>Method Detail |
---|
public void setRange(int rangeType, java.lang.String leftValue, java.lang.String rightValue)
rangeType
- the interval type ( CLOSED
, LEFT_OPENED
, RIGHT_OPENED
, OPENED
)leftValue
- the left or low valuerightValue
- the right or high valuepublic void setRange(int rangeType, java.lang.String value)
rangeType
- the range type ( EQUAL
, NOT_EQUAL
, LESS
, GREAT
, LESS_EQUAL
, GREAT_EQUAL
)value
- the reference valuepublic int getRangeType()
public java.lang.String getRangeTypeAsString()
public static int getTypeFromString(java.lang.String rangeType)
public java.lang.String getLeftValue()
public java.lang.String getRightValue()
public boolean isInterval()
public boolean isValidValue(java.lang.String value)
value
- the value to testpublic boolean equals(FieldRange range)
range
- the range to testpublic static int indexOf(java.util.Vector<FieldRange> ranges, FieldRange searchRange)
ranges
- a vector of FieldRangessearchRange
- the range to search
public java.lang.String getProperty(java.lang.String propertyName, java.util.Vector<java.lang.Object> filterArgs, java.lang.String sToken, Framework framework)
getProperty
in class OBBase
public java.util.Vector<?> getTargetNames(java.lang.String composedName, java.util.Vector<java.lang.Object> filterArgs, Framework framework)
getTargetNames
in class OBBase
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toString(boolean isString)
isString
- if true convert the range values as single quoted stringspublic org.jdom.Element toXML(Framework framework)
framework
- the current frameworkpublic org.jdom.Element toXML(boolean getImage, boolean fullDump, Framework framework)
toXML(Framework)
public void fromXML(org.jdom.Element rootElement)
fromXML
in class AdminComponent
public java.lang.String getCreateCommand(boolean force)
public java.lang.String getSaveCommand(boolean force)
|
OBEROn SDK | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |