LazySubject (Grouper API 2.5.0-SNAPSHOT Java API.)

java.lang.Object
- edu.internet2.middleware.grouper.subj.LazySubject

All Implemented Interfaces:

Subject, Serializable
```
public class LazySubject
extends Object
implements Subject
```
Subject from a Membership - getMember().getSubject() only called if necessary i.e. the UI pages results and so it is often not necessary to instantiate all the Subjects (and Members)

Version:

$Id: LazySubject.java,v 1.11 2009-10-31 16:27:12 mchyzer Exp $

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

LazySubject(Member member)

LazySubject(Membership ms)

Constructors
Constructor and Description
`LazySubject(Member member)`
`LazySubject(Membership ms)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Map`	`getAttributes()` Gets a map attribute names and values.
`Map<String,Set<String>>`	`getAttributes(boolean excludeInternalAttributes)` Gets a map attribute names and values.
`String`	`getAttributeValue(String name)` Returns the value of a single-valued attribute.
`String`	`getAttributeValue(String attributeName, boolean excludeInternalAttributes)` Returns the value of a single-valued attribute.
`String`	`getAttributeValueOrCommaSeparated(String attributeName)` Returns the attribute value if single-valued, or if multi-valued, returns the values comma separated (with a space too).
`String`	`getAttributeValueOrCommaSeparated(String attributeName, boolean excludeInternalAttributes)` Returns the attribute value if single-valued, or if multi-valued, returns the values comma separated (with a space too).
`Set`	`getAttributeValues(String name)` Returns the values of a multi-valued attribute, or a set of size one for a single valued attribute.
`Set<String>`	`getAttributeValues(String attributeName, boolean excludeInternalAttributes)` Returns the values of a multi-valued attribute, or a set of size one for a single valued attribute.
`String`	`getAttributeValueSingleValued(String attributeName)` Returns the attribute value if single-valued, or if multi-valued, throws an exception.
`String`	`getAttributeValueSingleValued(String attributeName, boolean excludeInternalAttributes)` Returns the attribute value if single-valued, or if multi-valued, throws an exception.
`String`	`getDescription()` Gets this Subject's description.
`String`	`getId()` Gets this Subject's ID.
`Membership`	`getMembership()`
`String`	`getName()` Gets this Subject's name.
`Source`	`getSource()` Returns the Source of this Subject.
`String`	`getSourceId()` get the source id
`Map<String,Object>`	`getTranslationMap()` we want to resolve virtual translated attributes when they are needed so store a map of subject and source attributes for that translation
`SubjectType`	`getType()` Gets this Subject's type.
`String`	`getTypeName()` get the type name
`int`	`hashCode()`
`void`	`setTranslationMap(Map<String,Object> translationMap)` we want to resolve virtual translated attributes when they are needed so store a map of subject and source attributes for that translation
`String`	`toString()`

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

- Constructor Detail
  - LazySubject
```
public LazySubject(Membership ms)
```
    Parameters:
    
    ms -
  - LazySubject
```
public LazySubject(Member member)
```
    Parameters:
    
    member -
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    See Also:
    
    Object.toString()
  - getAttributes
```
public Map getAttributes()
```
    Description copied from interface: Subject
    
    Gets a map attribute names and values. The map's key contains the attribute name and the map's value contains a Set of attribute value(s). This does not return internal attributes. Note, the keys are case-insensitive
    
    Specified by:
    
    getAttributes in interface Subject
    
    Returns:
    
    map or empty map or null if not there
    
    See Also:
    
    Subject.getAttributes()
  - getAttributeValue
```
public String getAttributeValue(String name)
```
    Description copied from interface: Subject
    
    Returns the value of a single-valued attribute. If multivalued, this returns the first value. This does not return values for internal attributes. Note, the keys are case-insensitive
    
    Specified by:
    
    getAttributeValue in interface Subject
    
    Returns:
    
    value or null if not found
    
    See Also:
    
    Subject.getAttributeValue(java.lang.String)
  - getAttributeValues
```
public Set getAttributeValues(String name)
```
    Description copied from interface: Subject
    
    Returns the values of a multi-valued attribute, or a set of size one for a single valued attribute. Note the returned set should not be changed. This does not return values for internal attributes. Note, the keys are case-insensitive
    
    Specified by:
    
    getAttributeValues in interface Subject
    
    Returns:
    
    set or empty set or null if not there
    
    See Also:
    
    Subject.getAttributeValues(java.lang.String)
  - getDescription
```
public String getDescription()
```
    Description copied from interface: Subject
    
    Gets this Subject's description.
    
    Specified by:
    
    getDescription in interface Subject
    
    Returns:
    
    description or null if not there
    
    See Also:
    
    Subject.getDescription()
  - getId
```
public String getId()
```
    Description copied from interface: Subject
    
    Gets this Subject's ID.
    
    Specified by:
    
    getId in interface Subject
    
    Returns:
    
    string
    
    See Also:
    
    Subject.getId()
  - getName
```
public String getName()
```
    Description copied from interface: Subject
    
    Gets this Subject's name.
    
    Specified by:
    
    getName in interface Subject
    
    Returns:
    
    name or null if not there
    
    See Also:
    
    Subject.getName()
  - getSource
```
public Source getSource()
```
    Description copied from interface: Subject
    
    Returns the Source of this Subject.
    
    Specified by:
    
    getSource in interface Subject
    
    Returns:
    
    source
    
    See Also:
    
    Subject.getSource()
  - getSourceId
```
public String getSourceId()
```
    get the source id
    
    Specified by:
    
    getSourceId in interface Subject
    
    Returns:
    
    the soruce id
  - getType
```
public SubjectType getType()
```
    Description copied from interface: Subject
    
    Gets this Subject's type.
    
    Specified by:
    
    getType in interface Subject
    
    Returns:
    
    subject type
    
    See Also:
    
    Subject.getType()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
    
    See Also:
    
    Object.equals(java.lang.Object)
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
    
    See Also:
    
    Object.hashCode()
  - getMembership
```
public Membership getMembership()
```
    Returns:
    
    membership
  - getTypeName
```
public String getTypeName()
```
    Description copied from interface: Subject
    
    get the type name
    
    Specified by:
    
    getTypeName in interface Subject
    
    Returns:
    
    the type name
    
    See Also:
    
    Subject.getTypeName()
  - getAttributeValueOrCommaSeparated
```
public String getAttributeValueOrCommaSeparated(String attributeName)
```
    Description copied from interface: Subject
```
 Returns the attribute value if single-valued, or
 if multi-valued, returns the values comma separated (with a space too).
 So if the values are: a b c; this would return the string: "a, b, c"
 Implementors can use the static helper in SubjectImpl.
 This does not return values for internal attributes.
 Note, the keys are case-insensitive
 
```
    Specified by:
    
    getAttributeValueOrCommaSeparated in interface Subject
    
    Returns:
    
    value or values or null if not there
    
    See Also:
    
    Subject.getAttributeValueOrCommaSeparated(java.lang.String)
  - getAttributeValueSingleValued
```
public String getAttributeValueSingleValued(String attributeName)
```
    Description copied from interface: Subject
    
    Returns the attribute value if single-valued, or if multi-valued, throws an exception. Implementors can use the static helper in SubjectImpl. This does not return values for internal attributes. Note, the keys are case-insensitive
    
    Specified by:
    
    getAttributeValueSingleValued in interface Subject
    
    Returns:
    
    value or null if not there
    
    See Also:
    
    Subject.getAttributeValueSingleValued(java.lang.String)
  - getAttributeValue
```
public String getAttributeValue(String attributeName,
                                boolean excludeInternalAttributes)
```
    Description copied from interface: Subject
    
    Returns the value of a single-valued attribute. If multivalued, this returns the first value. Note, the keys are case-insensitive
    
    Specified by:
    
    getAttributeValue in interface Subject
    
    excludeInternalAttributes - if true, values for internal attributes are not returned
    
    Returns:
    
    value or null if not found
    
    See Also:
    
    Subject.getAttributeValue(java.lang.String, boolean)
  - getAttributeValues
```
public Set<String> getAttributeValues(String attributeName,
                                      boolean excludeInternalAttributes)
```
    Description copied from interface: Subject
    
    Returns the values of a multi-valued attribute, or a set of size one for a single valued attribute. Note the returned set should not be changed. Note, the keys are case-insensitive
    
    Specified by:
    
    getAttributeValues in interface Subject
    
    excludeInternalAttributes - if true, values for internal attributes are not returned
    
    Returns:
    
    set or empty set or null if not there
    
    See Also:
    
    Subject.getAttributeValues(java.lang.String, boolean)
  - getAttributeValueOrCommaSeparated
```
public String getAttributeValueOrCommaSeparated(String attributeName,
                                                boolean excludeInternalAttributes)
```
    Description copied from interface: Subject
```
 Returns the attribute value if single-valued, or
 if multi-valued, returns the values comma separated (with a space too).
 So if the values are: a b c; this would return the string: "a, b, c"
 Implementors can use the static helper in SubjectImpl.
 Note, the keys are case-insensitive
 
```
    Specified by:
    
    getAttributeValueOrCommaSeparated in interface Subject
    
    excludeInternalAttributes - if true, values for internal attributes are not returned
    
    Returns:
    
    value or values or null if not there
    
    See Also:
    
    Subject.getAttributeValueOrCommaSeparated(java.lang.String, boolean)
  - getAttributeValueSingleValued
```
public String getAttributeValueSingleValued(String attributeName,
                                            boolean excludeInternalAttributes)
```
    Description copied from interface: Subject
    
    Returns the attribute value if single-valued, or if multi-valued, throws an exception. Implementors can use the static helper in SubjectImpl. Note, the keys are case-insensitive
    
    Specified by:
    
    getAttributeValueSingleValued in interface Subject
    
    excludeInternalAttributes - if true, values for internal attributes are not returned
    
    Returns:
    
    value or null if not there
    
    See Also:
    
    Subject.getAttributeValueSingleValued(java.lang.String, boolean)
  - getAttributes
```
public Map<String,Set<String>> getAttributes(boolean excludeInternalAttributes)
```
    Description copied from interface: Subject
    
    Gets a map attribute names and values. The map's key contains the attribute name and the map's value contains a Set of attribute value(s). The returned Map can be augmented or changed. Note, the keys are case-insensitive
    
    Specified by:
    
    getAttributes in interface Subject
    
    Parameters:
    
    excludeInternalAttributes - if true, internal attributes are not returned
    
    Returns:
    
    map or empty map or null if not there
    
    See Also:
    
    Subject.getAttributes(boolean)
  - getTranslationMap
```
public Map<String,Object> getTranslationMap()
```
    Description copied from interface: Subject
    
    we want to resolve virtual translated attributes when they are needed so store a map of subject and source attributes for that translation
    
    Specified by:
    
    getTranslationMap in interface Subject
    
    Returns:
  - setTranslationMap
```
public void setTranslationMap(Map<String,Object> translationMap)
```
    Description copied from interface: Subject
    
    we want to resolve virtual translated attributes when they are needed so store a map of subject and source attributes for that translation
    
    Specified by:
    
    setTranslationMap in interface Subject

Class LazySubject

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LazySubject

LazySubject

Method Detail

toString

getAttributes

getAttributeValue

getAttributeValues

getDescription

getId

getName

getSource

getSourceId

getType

equals

hashCode

getMembership

getTypeName

getAttributeValueOrCommaSeparated

getAttributeValueSingleValued

getAttributeValue

getAttributeValues

getAttributeValueOrCommaSeparated

getAttributeValueSingleValued

getAttributes

getTranslationMap

setTranslationMap