VClass (Vitro API 1.9.0-alpha-2 API)

java.lang.Object
- edu.cornell.mannlib.vitro.webapp.beans.BaseResourceBean
- - edu.cornell.mannlib.vitro.webapp.beans.VClass

All Implemented Interfaces:

ResourceBean, Comparable<VClass>

Direct Known Subclasses:

VClassJena, VClassList
```
public class VClass
extends BaseResourceBean
implements Comparable<VClass>
```
A Java class representing an ontology ("Vitro") class [kwg8-07/30/07]: comments [kwg8-07/30/07]: comments, naming cleanup

Nested Class Summary
- Nested classes/interfaces inherited from class edu.cornell.mannlib.vitro.webapp.beans.BaseResourceBean
  BaseResourceBean.RoleLevel

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`customDisplayView`
`protected String`	`customEntryForm`
`protected String`	`customSearchView`
`protected String`	`customShortView`
`protected Integer`	`displayLimit`
`protected Integer`	`displayRank`
`protected VClassGroup`	`group`
`protected String`	`groupURI`
`protected String`	`myDescription` Information about the type of information expected of a member of this VClass
`protected int`	`myEntityCount`
`protected String`	`myExample` An example member of this VClass
`protected String`	`myName` What this VClass is called
`protected String`	`myShortDefinition`
`protected String`	`quickEditJsp`
`protected Float`	`searchBoost`

Fields inherited from class edu.cornell.mannlib.vitro.webapp.beans.BaseResourceBean
hiddenFromDisplayBelowRoleLevel, hiddenFromPublishBelowRoleLevel, localName, localNameWithPrefix, namespace, pickListName, prohibitedFromUpdateBelowRoleLevel, URI

Constructor Summary

Constructors
Constructor and Description
`VClass()` Default constructor
`VClass(String uriString)` Constructs the VClass with a given URI
`VClass(String namespace, String localName, String vclassName)` Constructs the VClass from a URI that has been separated into namespace and localName components.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(VClass o1)` Sorts alphabetically by name
`VClass`	`copy()` Constructs the VClass as a deep copy of an existing VClass.
`protected void`	`copyFields(VClass that)`
`String`	`getCustomDisplayView()`
`String`	`getCustomEntryForm()`
`String`	`getCustomSearchView()`
`String`	`getCustomShortView()`
`String`	`getDescription()`
`int`	`getDisplayLimit()`
`int`	`getDisplayRank()`
`int`	`getEntityCount()`
`String`	`getExample()`
`VClassGroup`	`getGroup()`
`String`	`getGroupURI()`
`String`	`getName()`
`String`	`getQuickEditJsp()`
`Float`	`getSearchBoost()`
`String`	`getShortDef()`
`List<VClass>`	`getUnionComponents()`
`boolean`	`isUnion()`
`void`	`setCustomDisplayView(String s)`
`void`	`setCustomEntryForm(String s)`
`void`	`setCustomSearchView(String s)`
`void`	`setCustomShortView(String s)`
`void`	`setDescription(String descr)`
`void`	`setDisplayLimit(int displayLimit)`
`void`	`setDisplayRank(int displayRank)`
`void`	`setEntityCount(int ec)`
`void`	`setExample(String example)`
`void`	`setGroup(VClassGroup vcg)`
`void`	`setGroupURI(String groupURI)`
`void`	`setName(String name)`
`void`	`setQuickEditJsp(String quickEditJsp)`
`void`	`setSearchBoost(Float boost)`
`void`	`setShortDef(String sd)`
`String`	`toString()` Converts the VClass to a string

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

Field Detail

myName
```
protected String myName
```
What this VClass is called

myExample
```
protected String myExample
```
An example member of this VClass

myDescription
```
protected String myDescription
```
Information about the type of information expected of a member of this VClass

myShortDefinition
```
protected String myShortDefinition
```

myEntityCount
```
protected int myEntityCount
```

displayLimit
```
protected Integer displayLimit
```

quickEditJsp
```
protected String quickEditJsp
```

displayRank
```
protected Integer displayRank
```

groupURI
```
protected String groupURI
```

group
```
protected VClassGroup group
```

customEntryForm
```
protected String customEntryForm
```

customDisplayView
```
protected String customDisplayView
```

customShortView
```
protected String customShortView
```

customSearchView
```
protected String customSearchView
```

searchBoost
```
protected Float searchBoost
```

Constructor Detail
- VClass
```
public VClass()
```
  Default constructor
- VClass
```
public VClass(String namespace,
              String localName,
              String vclassName)
```
  Constructs the VClass from a URI that has been separated into namespace and localName components.
  
  Parameters:
  
  namespace - The name-space for the URI
  
  localName - The local name for this URI
  
  vclassName - The name of the VClass
- VClass
```
public VClass(String uriString)
```
  Constructs the VClass with a given URI
  
  Parameters:
  
  uriString - The source string with which to create this URI

Method Detail

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getExample
```
public String getExample()
```

setExample

public void setExample(String example)

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String descr)

getShortDef
```
public String getShortDef()
```

setShortDef
```
public void setShortDef(String sd)
```

getEntityCount
```
public int getEntityCount()
```

setEntityCount
```
public void setEntityCount(int ec)
```

getDisplayLimit
```
public int getDisplayLimit()
```

setDisplayLimit

public void setDisplayLimit(int displayLimit)

getQuickEditJsp
```
public String getQuickEditJsp()
```

setQuickEditJsp

public void setQuickEditJsp(String quickEditJsp)

getDisplayRank
```
public int getDisplayRank()
```

setDisplayRank

public void setDisplayRank(int displayRank)

getGroupURI
```
public String getGroupURI()
```

setGroupURI

public void setGroupURI(String groupURI)

getGroup
```
public VClassGroup getGroup()
```

setGroup

public void setGroup(VClassGroup vcg)

getCustomEntryForm
```
public String getCustomEntryForm()
```

setCustomEntryForm

public void setCustomEntryForm(String s)

getCustomDisplayView
```
public String getCustomDisplayView()
```

setCustomDisplayView

public void setCustomDisplayView(String s)

getCustomShortView
```
public String getCustomShortView()
```

setCustomShortView

public void setCustomShortView(String s)

getCustomSearchView
```
public String getCustomSearchView()
```

setCustomSearchView

public void setCustomSearchView(String s)

getSearchBoost
```
public Float getSearchBoost()
```

setSearchBoost

public void setSearchBoost(Float boost)

isUnion
```
public boolean isUnion()
```

getUnionComponents

public List<VClass> getUnionComponents()

copy
```
public VClass copy()
```
Constructs the VClass as a deep copy of an existing VClass.

copyFields

protected void copyFields(VClass that)

compareTo
```
public int compareTo(VClass o1)
```
Sorts alphabetically by name

Specified by:

compareTo in interface Comparable<VClass>

toString
```
public String toString()
```
Converts the VClass to a string

Overrides:

toString in class Object

Class VClass

Nested Class Summary

Nested classes/interfaces inherited from class edu.cornell.mannlib.vitro.webapp.beans.BaseResourceBean

Field Summary

Fields inherited from class edu.cornell.mannlib.vitro.webapp.beans.BaseResourceBean

Constructor Summary

Method Summary

Methods inherited from class edu.cornell.mannlib.vitro.webapp.beans.BaseResourceBean

Methods inherited from class java.lang.Object

Field Detail

myName

myExample

myDescription

myShortDefinition

myEntityCount

displayLimit

quickEditJsp

displayRank

groupURI

group

customEntryForm

customDisplayView

customShortView

customSearchView

searchBoost

Constructor Detail

VClass

VClass

VClass

Method Detail

getName

setName

getExample

setExample

getDescription

setDescription

getShortDef

setShortDef

getEntityCount

setEntityCount

getDisplayLimit

setDisplayLimit

getQuickEditJsp

setQuickEditJsp

getDisplayRank

setDisplayRank

getGroupURI

setGroupURI

getGroup

setGroup

getCustomEntryForm

setCustomEntryForm

getCustomDisplayView

setCustomDisplayView

getCustomShortView

setCustomShortView

getCustomSearchView

setCustomSearchView

getSearchBoost

setSearchBoost

isUnion

getUnionComponents

copy

copyFields

compareTo

toString