|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.opencyc.cycobject.CycVariable
Provides the behavior and attributes of an OpenCyc variable, typically used in rule and query expressions.
Copyright 2001 Cycorp, Inc., license is open source GNU LGPL.
THIS SOFTWARE AND KNOWLEDGE BASE CONTENT ARE PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OPENCYC ORGANIZATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE AND KNOWLEDGE BASE CONTENT, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Field Summary | |
static java.lang.String |
cycVariableXMLTag
The name of the XML tag for this object. |
java.lang.Integer |
id
The ID of the CycVariable object which is an integer unique within an OpenCyc KB but not necessarily unique globally. |
java.lang.String |
name
The variable represented as a String. |
Constructor Summary | |
CycVariable()
Constructs a new empty CycVariable object. |
|
CycVariable(java.lang.String name)
Constructs a new CycVariable object. |
Method Summary | |
int |
compareTo(java.lang.Object object)
Compares this object with the specified object for order. |
java.lang.String |
cyclify()
Returns the OpenCyc representation of the CycVariable |
java.lang.Object |
cycListApiValue()
Returns this object in a form suitable for use as an CycList api expression value. |
boolean |
equals(java.lang.Object object)
Returns true some object equals this CycVariable |
java.lang.String |
safeToString()
Returns a string representation without causing additional api calls to determine constant names. |
java.lang.String |
stringApiValue()
Returns this object in a form suitable for use as an String api expression value. |
java.lang.String |
toString()
Returns the string representation of the CycVariable |
void |
toXML(XMLWriter xmlWriter,
int indent,
boolean relative)
Prints the XML representation of the CycVariable to an XMLWriter |
java.lang.String |
toXMLString()
Returns the XML representation of this object. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String cycVariableXMLTag
public java.lang.String name
public java.lang.Integer id
Constructor Detail |
public CycVariable()
public CycVariable(java.lang.String name)
name
- the String name of the CycVariable.Method Detail |
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String safeToString()
public java.lang.String cyclify()
public java.lang.String stringApiValue()
public java.lang.Object cycListApiValue()
public boolean equals(java.lang.Object object)
equals
in class java.lang.Object
object
- the Object for equality comparisonpublic int compareTo(java.lang.Object object)
compareTo
in interface java.lang.Comparable
object
- the reference object with which to compare.public java.lang.String toXMLString() throws java.io.IOException
public void toXML(XMLWriter xmlWriter, int indent, boolean relative) throws java.io.IOException
XMLWriter
xmlWriter
- an XMLWriterindent
- an int that specifies by how many spaces to indentrelative
- a boolean; if true indentation is relative, otherwise absolute
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |