Property (Plasma Core 2.1.5 API)

java.lang.Object
- org.plasma.query.model.AbstractProperty
- - org.plasma.query.model.Property

All Implemented Interfaces:

Comparable<AbstractProperty>, DataProperty, IntegralDataProperty, Property, RealDataProperty, StringDataProperty, TemporalDataProperty, Term
```
public class Property
extends AbstractProperty
implements StringDataProperty, IntegralDataProperty, RealDataProperty, TemporalDataProperty
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`alias`
`protected Projection`	`as`
`protected SortDirection`	`direction`
`protected Boolean`	`distinct`
`protected List<Function>`	`functions`
`protected String`	`name`
`protected String`	`physicalName` Stores the physical name associated with this property.
`protected byte[]`	`physicalNameBytes` Stores the physical name bytes associated with this property.
`protected Query`	`query`
`protected Boolean`	`values`

Fields inherited from class org.plasma.query.model.AbstractProperty
path, qualifiedName, typeUniqueId, uniqueId

Constructor Summary

Constructors
Constructor and Description
`Property()`
`Property(String name)`
`Property(String name, FunctionName function)`
`Property(String name, Path path)`
`Property(String name, Path path, Query query)`
`Property(String name, Path path, SortDirection direction)`
`Property(String name, Query query)`
`Property(String name, SortDirection direction)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IntegralDataProperty`	`abs()` Constructs a value function, which returns absolute value of the data, and returns this data property for use in subsequent operations
`void`	`accept(QueryVisitor visitor)`
`DataProperty`	`asc()` Constructs a ascending ordering within this data property and returns the data property for use in subsequent operations
`String`	`asPathString()` Returns the path qualified name for this property, i.e.
`DataProperty`	`avg()` Constructs a average aggregate within this data property and returns the data property for use in subsequent operations
`Expression`	`between(Object min, Object max)` Returns a 6 term expression, where this property is greater than or equal to the given 'min' literal, and is less than or equal tothe given 'max' literal.
`RealDataProperty`	`ceiling()` Constructs a function, which returns the smallest integer that is greater than the number, and returns this data property for use in subsequent operations
`int`	`compareTo(AbstractProperty o)`
`DataProperty`	`count()` Constructs a count aggregate within this data property and returns the data property for use in subsequent operations
`DataProperty`	`desc()` Constructs a descending ordering within this data property and returns the data property for use in subsequent operations
`Expression`	`eq(Object value)` Returns a boolean expression where this property is equal to to the given literal.
`boolean`	`equals(Object obj)`
`Expression`	`exists(Query subquery)`
`RealDataProperty`	`floor()` Constructs a function, which returns the largest integer that is greater than the number, and returns this data property for use in subsequent operations
`static Property`	`forName(String name)` Factory method returning a property for the given name.
`static Property`	`forName(String name, Path path)` Factory method returning a property for the given name and path.
`Expression`	`ge(Object value)` Returns a boolean expression where this property is greater than or equal to the given literal.
`String`	`getAlias()` Gets the value of the alias property.
`Projection`	`getAs()`
`SortDirection`	`getDirection()`
`List<Function>`	`getFunctions()`
`String`	`getName()` returns the name of this property
`String`	`getPhysicalName()`
`byte[]`	`getPhysicalNameBytes()`
`String`	`getQualifiedName()`
`Query`	`getQuery()`
`Expression`	`gt(Object value)` Returns a boolean expression where this property is greater than the given literal.
`int`	`hashCode()`
`Expression`	`in(Query subquery)` Returns a subquery expression, where this property is found within the given subquery results collection.
`boolean`	`isDistinct()` Gets the value of the distinct property.
`Expression`	`isNotNull()` Returns a boolean expression where this property is not equal to null.
`Expression`	`isNull()` Returns a boolean expression where this property is equal to null.
`boolean`	`isValues()`
`Expression`	`le(Object value)` Returns a boolean expression where this property is less than or equal to the given literal.
`Expression`	`like(String value)` Returns a wildcard expression where this property is like the given literal, and the literal may contain any number of wildcards, the wildcard character being '*'
`StringDataProperty`	`lowerCase()` Constructs a function, which returns the lower case for the string data, and returns this data property for use in subsequent operations
`Expression`	`lt(Object value)` Returns a boolean expression where this property is less than the given literal.
`DataProperty`	`max()` Constructs a maximum aggregate within this data property and returns the data property for use in subsequent operations
`DataProperty`	`min()` Constructs a minimum aggregate within this data property and returns the data property for use in subsequent operations
`Expression`	`ne(Object value)` Returns a boolean expression where this property is not equal to to the given literal.
`StringDataProperty`	`normalizeSpace()` Constructs a function, which removes leading and trailing spaces from the specified string, and replaces all internal sequences of white space with one and returns the result.
`Expression`	`notIn(Query subquery)` Returns a subquery expression, where this property is not found within the given subquery results collection.
`RealDataProperty`	`round()` Constructs a function, which returns the nearest integer, and returns this data property for use in subsequent operations
`void`	`setAlias(String value)` Sets the value of the alias property.
`void`	`setAs(Projection value)`
`void`	`setDirection(SortDirection value)`
`void`	`setDistinct(Boolean value)`
`void`	`setName(String value)`
`void`	`setPhysicalName(String value)`
`void`	`setPhysicalNameBytes(byte[] value)`
`void`	`setQuery(Query value)`
`void`	`setValues(Boolean value)`
`StringDataProperty`	`substringAfter(String value)` Constructs a function, which returns the tail of the string data after the given string value occurs in it, and returns this data property for use in subsequent operations
`StringDataProperty`	`substringBefore(String value)` Constructs a function, which returns the start of the string data before the given string value occurs in it, and returns this data property for use in subsequent operations
`DataProperty`	`sum()` Constructs a summation aggregate within this data property and returns the data property for use in subsequent operations
`String`	`toString()`
`StringDataProperty`	`upperCase()` Constructs a function, which returns the upper case for the string data, and returns this data property for use in subsequent operations
`static WildcardProperty`	`wildcard()`
`static WildcardProperty`	`wildcard(Path path)`

Methods inherited from class org.plasma.query.model.AbstractProperty
getPath, getTypeUniqueId, getUniqueId, setPath, setTypeUniqueId, setUniqueId

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - query
```
protected Query query
```
  - as
```
protected Projection as
```
  - functions
```
protected List<Function> functions
```
  - name
```
protected String name
```
  - values
```
protected Boolean values
```
  - distinct
```
protected Boolean distinct
```
  - direction
```
protected SortDirection direction
```
  - alias
```
protected String alias
```
  - physicalName
```
protected transient String physicalName
```
    Stores the physical name associated with this property. Can be used by service providers for query post processing. This field is not processed during XML or other serialization operations.
  - physicalNameBytes
```
protected transient byte[] physicalNameBytes
```
    Stores the physical name bytes associated with this property. Can be used by service providers for query post processing. This field is not processed during XML or other serialization operations.
- Constructor Detail
  - Property
```
public Property()
```
  - Property
```
public Property(String name)
```
  - Property
```
public Property(String name,
                Path path)
```
  - Property
```
public Property(String name,
                SortDirection direction)
```
  - Property
```
public Property(String name,
                Path path,
                SortDirection direction)
```
  - Property
```
public Property(String name,
                FunctionName function)
```
  - Property
```
public Property(String name,
                Query query)
```
  - Property
```
public Property(String name,
                Path path,
                Query query)
```
- Method Detail
  - forName
```
public static Property forName(String name)
```
    Factory method returning a property for the given name.
  - forName
```
public static Property forName(String name,
                               Path path)
```
    Factory method returning a property for the given name and path.
  - wildcard
```
public static WildcardProperty wildcard()
```
  - wildcard
```
public static WildcardProperty wildcard(Path path)
```
  - eq
```
public Expression eq(Object value)
```
    Description copied from interface: DataProperty
    
    Returns a boolean expression where this property is equal to to the given literal.
    
    Specified by:
    
    eq in interface DataProperty
    
    Parameters:
    
    value - the literal
    
    Returns:
    
    the boolean expression
  - ne
```
public Expression ne(Object value)
```
    Description copied from interface: DataProperty
    
    Returns a boolean expression where this property is not equal to to the given literal.
    
    Specified by:
    
    ne in interface DataProperty
    
    Parameters:
    
    value - the literal
    
    Returns:
    
    the boolean expression
  - gt
```
public Expression gt(Object value)
```
    Description copied from interface: DataProperty
    
    Returns a boolean expression where this property is greater than the given literal.
    
    Specified by:
    
    gt in interface DataProperty
    
    Parameters:
    
    value - the literal
    
    Returns:
    
    the boolean expression
  - ge
```
public Expression ge(Object value)
```
    Description copied from interface: DataProperty
    
    Returns a boolean expression where this property is greater than or equal to the given literal.
    
    Specified by:
    
    ge in interface DataProperty
    
    Parameters:
    
    value - the literal
    
    Returns:
    
    the boolean expression
  - lt
```
public Expression lt(Object value)
```
    Description copied from interface: DataProperty
    
    Returns a boolean expression where this property is less than the given literal.
    
    Specified by:
    
    lt in interface DataProperty
    
    Parameters:
    
    value - the literal
    
    Returns:
    
    the boolean expression
  - le
```
public Expression le(Object value)
```
    Description copied from interface: DataProperty
    
    Returns a boolean expression where this property is less than or equal to the given literal.
    
    Specified by:
    
    le in interface DataProperty
    
    Parameters:
    
    value - the literal
    
    Returns:
    
    the boolean expression
  - between
```
public Expression between(Object min,
                          Object max)
```
    Description copied from interface: DataProperty
    
    Returns a 6 term expression, where this property is greater than or equal to the given 'min' literal, and is less than or equal tothe given 'max' literal.
    
    Specified by:
    
    between in interface DataProperty
    
    Parameters:
    
    min - the minimum literal
    
    max - the maximum literal
    
    Returns:
    
    the expression
  - like
```
public Expression like(String value)
```
    Description copied from interface: DataProperty
    
    Returns a wildcard expression where this property is like the given literal, and the literal may contain any number of wildcards, the wildcard character being '*'
    
    Specified by:
    
    like in interface DataProperty
    
    Parameters:
    
    value - the wildcard literal
    
    Returns:
    
    the wildcard expression
  - isNull
```
public Expression isNull()
```
    Description copied from interface: DataProperty
    
    Returns a boolean expression where this property is equal to null.
    
    Specified by:
    
    isNull in interface DataProperty
    
    Returns:
    
    the boolean expression
  - isNotNull
```
public Expression isNotNull()
```
    Description copied from interface: DataProperty
    
    Returns a boolean expression where this property is not equal to null.
    
    Specified by:
    
    isNotNull in interface DataProperty
    
    Returns:
    
    the boolean expression
  - in
```
public Expression in(Query subquery)
```
    Description copied from interface: DataProperty
    
    Returns a subquery expression, where this property is found within the given subquery results collection.
    
    Specified by:
    
    in in interface DataProperty
    
    Parameters:
    
    subquery - the subquery
    
    Returns:
    
    the subquery expression
  - notIn
```
public Expression notIn(Query subquery)
```
    Description copied from interface: DataProperty
    
    Returns a subquery expression, where this property is not found within the given subquery results collection.
    
    Specified by:
    
    notIn in interface DataProperty
    
    Parameters:
    
    subquery - the subquery
    
    Returns:
    
    the subquery expression
  - exists
```
public Expression exists(Query subquery)
```
  - getQuery
```
public Query getQuery()
```
  - setQuery
```
public void setQuery(Query value)
```
  - count
```
public DataProperty count()
```
    Description copied from interface: DataProperty
    
    Constructs a count aggregate within this data property and returns the data property for use in subsequent operations
    
    Specified by:
    
    count in interface DataProperty
    
    Returns:
    
    the data property
  - min
```
public DataProperty min()
```
    Description copied from interface: DataProperty
    
    Constructs a minimum aggregate within this data property and returns the data property for use in subsequent operations
    
    Specified by:
    
    min in interface DataProperty
    
    Returns:
    
    the data property
  - max
```
public DataProperty max()
```
    Description copied from interface: DataProperty
    
    Constructs a maximum aggregate within this data property and returns the data property for use in subsequent operations
    
    Specified by:
    
    max in interface DataProperty
    
    Returns:
    
    the data property
  - sum
```
public DataProperty sum()
```
    Description copied from interface: DataProperty
    
    Constructs a summation aggregate within this data property and returns the data property for use in subsequent operations
    
    Specified by:
    
    sum in interface DataProperty
    
    Returns:
    
    the data property
  - avg
```
public DataProperty avg()
```
    Description copied from interface: DataProperty
    
    Constructs a average aggregate within this data property and returns the data property for use in subsequent operations
    
    Specified by:
    
    avg in interface DataProperty
    
    Returns:
    
    the data property
  - abs
```
public IntegralDataProperty abs()
```
    Description copied from interface: IntegralDataProperty
    
    Constructs a value function, which returns absolute value of the data, and returns this data property for use in subsequent operations
    
    Specified by:
    
    abs in interface IntegralDataProperty
    
    Returns:
    
    this data property for use in subsequent operations
  - ceiling
```
public RealDataProperty ceiling()
```
    Description copied from interface: RealDataProperty
    
    Constructs a function, which returns the smallest integer that is greater than the number, and returns this data property for use in subsequent operations
    
    Specified by:
    
    ceiling in interface RealDataProperty
    
    Returns:
    
    this data property for use in subsequent operations
  - floor
```
public RealDataProperty floor()
```
    Description copied from interface: RealDataProperty
    
    Constructs a function, which returns the largest integer that is greater than the number, and returns this data property for use in subsequent operations
    
    Specified by:
    
    floor in interface RealDataProperty
    
    Returns:
    
    this data property for use in subsequent operations
  - round
```
public RealDataProperty round()
```
    Description copied from interface: RealDataProperty
    
    Constructs a function, which returns the nearest integer, and returns this data property for use in subsequent operations
    
    Specified by:
    
    round in interface RealDataProperty
    
    Returns:
    
    this data property for use in subsequent operations
  - substringBefore
```
public StringDataProperty substringBefore(String value)
```
    Description copied from interface: StringDataProperty
    
    Constructs a function, which returns the start of the string data before the given string value occurs in it, and returns this data property for use in subsequent operations
    
    Specified by:
    
    substringBefore in interface StringDataProperty
    
    Returns:
    
    this data property for use in subsequent operations
  - substringAfter
```
public StringDataProperty substringAfter(String value)
```
    Description copied from interface: StringDataProperty
    
    Constructs a function, which returns the tail of the string data after the given string value occurs in it, and returns this data property for use in subsequent operations
    
    Specified by:
    
    substringAfter in interface StringDataProperty
    
    Returns:
    
    this data property for use in subsequent operations
  - normalizeSpace
```
public StringDataProperty normalizeSpace()
```
    Description copied from interface: StringDataProperty
    
    Constructs a function, which removes leading and trailing spaces from the specified string, and replaces all internal sequences of white space with one and returns the result.
    
    Specified by:
    
    normalizeSpace in interface StringDataProperty
    
    Returns:
    
    this data property for use in subsequent operations
  - upperCase
```
public StringDataProperty upperCase()
```
    Description copied from interface: StringDataProperty
    
    Constructs a function, which returns the upper case for the string data, and returns this data property for use in subsequent operations
    
    Specified by:
    
    upperCase in interface StringDataProperty
    
    Returns:
    
    this data property for use in subsequent operations
  - lowerCase
```
public StringDataProperty lowerCase()
```
    Description copied from interface: StringDataProperty
    
    Constructs a function, which returns the lower case for the string data, and returns this data property for use in subsequent operations
    
    Specified by:
    
    lowerCase in interface StringDataProperty
    
    Returns:
    
    this data property for use in subsequent operations
  - asc
```
public DataProperty asc()
```
    Description copied from interface: DataProperty
    
    Constructs a ascending ordering within this data property and returns the data property for use in subsequent operations
    
    Specified by:
    
    asc in interface DataProperty
    
    Returns:
    
    the data property
  - desc
```
public DataProperty desc()
```
    Description copied from interface: DataProperty
    
    Constructs a descending ordering within this data property and returns the data property for use in subsequent operations
    
    Specified by:
    
    desc in interface DataProperty
    
    Returns:
    
    the data property
  - getAs
```
public Projection getAs()
```
  - setAs
```
public void setAs(Projection value)
```
  - getFunctions
```
public List<Function> getFunctions()
```
  - getName
```
public String getName()
```
    Description copied from interface: DataProperty
    
    returns the name of this property
    
    Specified by:
    
    getName in interface DataProperty
    
    Returns:
  - setName
```
public void setName(String value)
```
  - getPhysicalName
```
public String getPhysicalName()
```
  - setPhysicalName
```
public void setPhysicalName(String value)
```
  - getPhysicalNameBytes
```
public byte[] getPhysicalNameBytes()
```
  - setPhysicalNameBytes
```
public void setPhysicalNameBytes(byte[] value)
```
  - isValues
```
public boolean isValues()
```
  - setValues
```
public void setValues(Boolean value)
```
  - isDistinct
```
public boolean isDistinct()
```
    Description copied from interface: DataProperty
    
    Gets the value of the distinct property.
    
    Specified by:
    
    isDistinct in interface DataProperty
    
    Returns:
    
    possible object is Boolean
  - setDistinct
```
public void setDistinct(Boolean value)
```
  - getDirection
```
public SortDirection getDirection()
```
  - setDirection
```
public void setDirection(SortDirection value)
```
  - getAlias
```
public String getAlias()
```
    Gets the value of the alias property.
    
    Returns:
    
    possible object is String
  - setAlias
```
public void setAlias(String value)
```
    Sets the value of the alias property.
    
    Parameters:
    
    value - allowed object is String
  - asPathString
```
public String asPathString()
```
    Returns the path qualified name for this property, i.e. as the final element within its associated path, if a path exists for this property. If no path exists for this property, simply the name of the property is returned.
    
    Returns:
    
    the path qualified name for this property
  - accept
```
public void accept(QueryVisitor visitor)
```
    Overrides:
    
    accept in class AbstractProperty
  - getQualifiedName
```
public String getQualifiedName()
```
    Specified by:
    
    getQualifiedName in class AbstractProperty
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - compareTo
```
public int compareTo(AbstractProperty o)
```
    Specified by:
    
    compareTo in interface Comparable<AbstractProperty>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Property

Field Summary

Fields inherited from class org.plasma.query.model.AbstractProperty

Constructor Summary

Method Summary

Methods inherited from class org.plasma.query.model.AbstractProperty

Methods inherited from class java.lang.Object

Field Detail

query

as

functions

name

values

distinct

direction

alias

physicalName

physicalNameBytes

Constructor Detail

Property

Property

Property

Property

Property

Property

Property

Property

Method Detail

forName

forName

wildcard

wildcard

eq

ne

gt

ge

lt

le

between

like

isNull

isNotNull

in

notIn

exists

getQuery

setQuery

count

min

max

sum

avg

abs

ceiling

floor

round

substringBefore

substringAfter

normalizeSpace

upperCase

lowerCase

asc

desc

getAs

setAs

getFunctions

getName

setName

getPhysicalName

setPhysicalName

getPhysicalNameBytes

setPhysicalNameBytes

isValues

setValues

isDistinct

setDistinct

getDirection

setDirection

getAlias

setAlias