org.gramar.gramar

Class SampleModel

java.lang.Object

org.gramar.gramar.SampleModel

All Implemented Interfaces:

ISampleModel

public class SampleModel
extends Object
implements ISampleModel

Represents and describes one of the sample models deployed with a gramar. Tools can ask a gramar for a list of its deployed sample models and jumpstart users by creating a file with one of those models.

Constructor Summary

Constructors

Constructor and Description
SampleModel(String name, String path, String description)

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription()
String	getName()
String	getPath()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SampleModel

public SampleModel(String name,
           String path,
           String description)

Method Detail

getName

public String getName()

Specified by:

getName in interface ISampleModel

Returns:

the unique, single-token name of the sample model

getPath

public String getPath()

Specified by:

getPath in interface ISampleModel

Returns:

the gramar-relative path of the resource containing the sample model

getDescription

public String getDescription()

Specified by:

getDescription in interface ISampleModel

Returns:

a short description of the model