AccountingClassification

java.lang.Object
- uk.ac.ed.epcc.webapp.model.data.DataObject
- - uk.ac.ed.epcc.webapp.model.Classification
  - - uk.ac.ed.epcc.safe.accounting.db.AccountingClassification

All Implemented Interfaces:

java.lang.Comparable<uk.ac.ed.epcc.webapp.model.Classification>, java.security.Principal, ExpressionTarget, PropertyContainer, PropertyTarget, UsageRecord, uk.ac.ed.epcc.webapp.Contexed, uk.ac.ed.epcc.webapp.ContextIndexed, uk.ac.ed.epcc.webapp.forms.Identified, uk.ac.ed.epcc.webapp.Indexed, uk.ac.ed.epcc.webapp.model.data.reference.ReferenceProvider
```
public class AccountingClassification
extends uk.ac.ed.epcc.webapp.model.Classification
implements PropertyContainer, ExpressionTarget, uk.ac.ed.epcc.webapp.model.data.reference.ReferenceProvider, UsageRecord
```
Represents an additional table of data used to classify accounting records into sets. This is achieved by having the accounting record reference an entry in the classification table. AccountingClassification objects also have properties associated with them which can be accessed in a PropExpression.

Author:

spb

Field Summary

Fields
Modifier and Type Field and Description

protected PropertyTargetClassificationFactory fac

protected ExpressionTargetContainer proxy
- Fields inherited from class uk.ac.ed.epcc.webapp.model.Classification
  DESCRIPTION, NAME, SORT_ORDER
- Fields inherited from class uk.ac.ed.epcc.webapp.model.data.DataObject
  DEBUG, record
- Fields inherited from interface uk.ac.ed.epcc.webapp.forms.Identified
  MAX_IDENTIFIER

Fields
Modifier and Type	Field and Description
`protected PropertyTargetClassificationFactory`	`fac`
`protected ExpressionTargetContainer`	`proxy`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AccountingClassification(PropertyTargetClassificationFactory<?> fac, uk.ac.ed.epcc.webapp.model.data.Repository.Record res)`

Method Summary

Methods
Modifier and Type	Method and Description
`<T> T`	`evaluateExpression(PropExpression<T> expr)` Evaluate an expression on the target object
`<T> T`	`evaluateExpression(PropExpression<T> expr, T def)` Evaluate expression with default.
`java.util.Set<PropertyTag>`	`getDefinedProperties()` Generate a set of all the properties defined in this container
`ExpressionTargetFactory`	`getExpressionTargetFactory()`
`PropertyTargetClassificationFactory<? extends AccountingClassification>`	`getFactory()`
`java.lang.Object`	`getKey()` Unique key for populating a Table Note the Table may have entries from more than one `UsageProducer`
`Parser`	`getParser()` Get a `Parser` used to parse expressions for this target.
`<T> T`	`getProperty(PropertyTag<T> tag)` Get the specified property from the container.
`<T> T`	`getProperty(PropertyTag<T> tag, T def)` Get property with default.
`uk.ac.ed.epcc.webapp.model.data.reference.IndexedReference`	`getReference()`
`void`	`setAll(PropertyContainer source)` Copy all compatible properties from one container to another;
`<T> void`	`setOptionalProperty(PropertyTag<? super T> tag, T value)` Set the specified property if it is supported
`<T> void`	`setProperty(PropertyTag<? super T> tag, T value)` Set the specified property
`<T> void`	`setProperty(PropertyTag<T> tag, PropertyContainer map)`
`boolean`	`supports(PropertyTag<?> tag)` Is the specified property supported by the container.
`boolean`	`writable(PropertyTag<?> tag)` Is the specified property supported for write.

Methods inherited from class uk.ac.ed.epcc.webapp.model.Classification
compareTo, getDescription, getIdentifier, getName, getTableSpecification, setName, toString

Methods inherited from class uk.ac.ed.epcc.webapp.model.data.DataObject
addToMap, addToMap, addToMap, commit, delete, empty, equals, formUpdate, getContext, getFactoryTag, getID, getIdentifier, getLogger, getMap, getRecord, getRecord, getRecord, getSQLContext, getUniqueIdName, hashCode, post_commit, postCreate, pre_commit, release, setContents, setDirty, setMap

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

Methods inherited from interface uk.ac.ed.epcc.webapp.Indexed
getID

Methods inherited from interface uk.ac.ed.epcc.safe.accounting.UsageRecord
getContext, getIdentifier

Methods inherited from interface java.security.Principal
equals, hashCode

- Field Detail
  - fac
```
protected final PropertyTargetClassificationFactory fac
```
  - proxy
```
protected final ExpressionTargetContainer proxy
```
- Constructor Detail
  - AccountingClassification
```
protected AccountingClassification(PropertyTargetClassificationFactory<?> fac,
                        uk.ac.ed.epcc.webapp.model.data.Repository.Record res)
```
- Method Detail
  - getProperty
```
public <T> T getProperty(PropertyTag<T> tag,
                T def)
```
    Description copied from interface: PropertyTarget
    
    Get property with default. If the property is not supported by the container of if no value has been set then the default value is returned.
    
    Specified by:
    
    getProperty in interface PropertyTarget
    
    Type Parameters:
    T - Type of property
    Parameters:
    tag - PropertTag identifying property
    def - default value
    
    Returns:
    property value or default.
  - setProperty
```
public final <T> void setProperty(PropertyTag<T> tag,
                   PropertyContainer map)
                       throws InvalidPropertyException
```
    Throws:
    
    InvalidPropertyException
  - getProperty
```
public final <T> T getProperty(PropertyTag<T> tag)
                    throws InvalidPropertyException
```
    Description copied from interface: PropertyContainer
    
    Get the specified property from the container. THe InvalidPropertyException should only be thrown if the supports method would have returned false for the requested property.
    
    Specified by:
    
    getProperty in interface PropertyContainer
    
    Throws:
    
    InvalidPropertyException
    Type Parameters:
    T - type of property
    Parameters:
    tag - PropertyTag identifying property
    
    Returns:
    value current value of property (may be null if not set).
  - setProperty
```
public final <T> void setProperty(PropertyTag<? super T> tag,
                   T value)
                       throws InvalidPropertyException
```
    Description copied from interface: PropertyContainer
    
    Set the specified property
    
    Specified by:
    
    setProperty in interface PropertyContainer
    
    Throws:
    
    InvalidPropertyException
    Type Parameters:
    T - type of property
    Parameters:
    tag - PropertyTag identifying property
  - setOptionalProperty
```
public final <T> void setOptionalProperty(PropertyTag<? super T> tag,
                           T value)
```
    Description copied from interface: PropertyContainer
    
    Set the specified property if it is supported
    
    Specified by:
    
    setOptionalProperty in interface PropertyContainer
    
    Type Parameters:
    T - type of property
    Parameters:
    tag - PropertyTag identifying property
  - supports
```
public final boolean supports(PropertyTag<?> tag)
```
    Description copied from interface: PropertyContainer
    
    Is the specified property supported by the container. If the container is unconstrained this always returns true
    
    Specified by:
    
    supports in interface PropertyContainer
    
    Returns:
    boolean true if property supported
  - writable
```
public final boolean writable(PropertyTag<?> tag)
```
    Description copied from interface: PropertyContainer
    
    Is the specified property supported for write. If the container is unconstrained this always returns true
    
    Specified by:
    
    writable in interface PropertyContainer
    
    Returns:
    boolean true if property can be written
  - evaluateExpression
```
public <T> T evaluateExpression(PropExpression<T> expr)
                     throws InvalidPropertyException
```
    Description copied from interface: ExpressionTarget
    
    Evaluate an expression on the target object
    
    Specified by:
    
    evaluateExpression in interface ExpressionTarget
    
    Throws:
    
    InvalidPropertyException
    Type Parameters:
    T - type of expression
    Parameters:
    expr - expression
    
    Returns:
    T
  - evaluateExpression
```
public <T> T evaluateExpression(PropExpression<T> expr,
                       T def)
```
    Description copied from interface: ExpressionTarget
    
    Evaluate expression with default. If the expression does not resolve then return the default value
    
    Specified by:
    
    evaluateExpression in interface ExpressionTarget
    
    Type Parameters:
    T - type of expression
    Parameters:
    expr - expression
    def - default value
    
    Returns:
    T
  - getExpressionTargetFactory
```
public ExpressionTargetFactory getExpressionTargetFactory()
```
  - getFactory
```
public PropertyTargetClassificationFactory<? extends AccountingClassification> getFactory()
```
  - getReference
```
public uk.ac.ed.epcc.webapp.model.data.reference.IndexedReference getReference()
```
    Specified by:
    
    getReference in interface uk.ac.ed.epcc.webapp.model.data.reference.ReferenceProvider
  - getDefinedProperties
```
public java.util.Set<PropertyTag> getDefinedProperties()
```
    Description copied from interface: PropertyContainer
    
    Generate a set of all the properties defined in this container
    
    Specified by:
    
    getDefinedProperties in interface PropertyContainer
    
    Returns:
    Set
  - setAll
```
public void setAll(PropertyContainer source)
```
    Description copied from interface: PropertyContainer
    
    Copy all compatible properties from one container to another;
    
    Specified by:
    
    setAll in interface PropertyContainer
    
    Parameters:
    source - PropertyContainer
  - getParser
```
public Parser getParser()
```
    Description copied from interface: ExpressionTarget
    
    Get a Parser used to parse expressions for this target.
    
    Specified by:
    
    getParser in interface ExpressionTarget
    
    Returns:
    Parser
  - getKey
```
public java.lang.Object getKey()
```
    Description copied from interface: UsageRecord
    
    Unique key for populating a Table Note the Table may have entries from more than one UsageProducer
    
    Specified by:
    
    getKey in interface UsageRecord
    
    Returns:
    Object unique to this table and record

Class AccountingClassification

Field Summary

Fields inherited from class uk.ac.ed.epcc.webapp.model.Classification

Fields inherited from class uk.ac.ed.epcc.webapp.model.data.DataObject

Fields inherited from interface uk.ac.ed.epcc.webapp.forms.Identified

Constructor Summary

Method Summary

Methods inherited from class uk.ac.ed.epcc.webapp.model.Classification

Methods inherited from class uk.ac.ed.epcc.webapp.model.data.DataObject

Methods inherited from class java.lang.Object

Methods inherited from interface uk.ac.ed.epcc.webapp.Indexed

Methods inherited from interface uk.ac.ed.epcc.safe.accounting.UsageRecord

Methods inherited from interface java.security.Principal

Field Detail

fac

proxy

Constructor Detail

AccountingClassification

Method Detail

getProperty

setProperty

getProperty

setProperty

setOptionalProperty

supports

writable

evaluateExpression

evaluateExpression

getExpressionTargetFactory

getFactory

getReference

getDefinedProperties

setAll

getParser

getKey