com.simplifiedlogic.nitro.jlink.impl

Class JLNote

java.lang.Object

com.simplifiedlogic.nitro.jlink.impl.JLNote

All Implemented Interfaces:

IJLNote

public class JLNote
extends java.lang.Object
implements IJLNote

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	JLNote.CopyLooper An implementation of ModelLooper which copies notes to a list of models
class	JLNote.SetLooper An implementation of ModelLooper which creates or updates a note on a list of models

Constructor Summary

Constructors

Constructor and Description
JLNote()

Method Summary

Methods

Modifier and Type	Method and Description
void	copy(java.lang.String filename, java.lang.String noteName, java.lang.String toModel, java.lang.String toName, AbstractJLISession sess)
void	copy(java.lang.String filename, java.lang.String noteName, java.lang.String toModel, java.lang.String toName, java.lang.String sessionId)
void	copyOneNote(CallDetailNoteItem note, CallModel m, java.lang.String toName) Copy a drawing note to a note in another model/drawing or to another note in the same drawing
void	delete(java.lang.String filename, java.lang.String noteName, AbstractJLISession sess)
void	delete(java.lang.String filename, java.lang.String noteName, java.lang.String sessionId)
boolean	exists(java.lang.String filename, java.lang.String noteName, java.util.List<java.lang.String> noteNames, AbstractJLISession sess)
boolean	exists(java.lang.String filename, java.lang.String noteName, java.util.List<java.lang.String> noteNames, java.lang.String sessionId)
NoteData	get(java.lang.String filename, java.lang.String noteName, AbstractJLISession sess)
NoteData	get(java.lang.String filename, java.lang.String noteName, java.lang.String sessionId)
static boolean	getNoteInfo(CallModel model, CallModelItem item, NoteData outvals, boolean encoded, boolean getExpandedValues) Get data about a model or drawing note
static boolean	getNoteInfo(CallModel model, CallModelItem item, NoteData outvals, boolean encoded, java.util.regex.Pattern valuePtn, boolean getExpandedValues) Get data about a model or drawing note
static java.lang.String	getNoteText(CallDetailNoteItem note, boolean expanded) Get the text of a drawing note.
static java.lang.String	getNoteText(CallNote note, boolean expanded) Get the text of a model note.
java.util.List<NoteData>	list(java.lang.String filename, java.lang.String noteName, java.util.List<java.lang.String> noteNames, java.lang.String valuePattern, boolean getExpandedValues, boolean select, AbstractJLISession sess)
java.util.List<NoteData>	list(java.lang.String filename, java.lang.String noteName, java.util.List<java.lang.String> noteNames, java.lang.String valuePattern, boolean getExpandedValues, boolean select, java.lang.String sessionId)
void	set(java.lang.String filename, java.lang.String noteName, java.lang.Object valueObj, boolean encoded, JLPoint location, AbstractJLISession sess)
void	set(java.lang.String filename, java.lang.String noteName, java.lang.Object valueObj, boolean encoded, JLPoint location, java.lang.String sessionId)
void	setLoc(java.lang.String filename, java.lang.String noteName, JLPoint location, AbstractJLISession sess)
void	setLoc(java.lang.String filename, java.lang.String noteName, JLPoint location, java.lang.String sessionId)
void	validateNoteName(java.lang.String name) Checks whether a note name is valid.

Methods inherited from class java.lang.Object

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

Constructor Detail

JLNote

public JLNote()

Method Detail

set

public void set(java.lang.String filename,
       java.lang.String noteName,
       java.lang.Object valueObj,
       boolean encoded,
       JLPoint location,
       java.lang.String sessionId)
         throws JLIException

Specified by:

set in interface IJLNote

Throws:

JLIException

set

public void set(java.lang.String filename,
       java.lang.String noteName,
       java.lang.Object valueObj,
       boolean encoded,
       JLPoint location,
       AbstractJLISession sess)
         throws JLIException

Specified by:

set in interface IJLNote

Throws:

JLIException

setLoc

public void setLoc(java.lang.String filename,
          java.lang.String noteName,
          JLPoint location,
          java.lang.String sessionId)
            throws JLIException

Specified by:

setLoc in interface IJLNote

Throws:

JLIException

setLoc

public void setLoc(java.lang.String filename,
          java.lang.String noteName,
          JLPoint location,
          AbstractJLISession sess)
            throws JLIException

Specified by:

setLoc in interface IJLNote

Throws:

JLIException

get

public NoteData get(java.lang.String filename,
           java.lang.String noteName,
           java.lang.String sessionId)
             throws JLIException

Specified by:

get in interface IJLNote

Throws:

JLIException

get

public NoteData get(java.lang.String filename,
           java.lang.String noteName,
           AbstractJLISession sess)
             throws JLIException

Specified by:

get in interface IJLNote

Throws:

JLIException

delete

public void delete(java.lang.String filename,
          java.lang.String noteName,
          java.lang.String sessionId)
            throws JLIException

Specified by:

delete in interface IJLNote

Throws:

JLIException

delete

public void delete(java.lang.String filename,
          java.lang.String noteName,
          AbstractJLISession sess)
            throws JLIException

Specified by:

delete in interface IJLNote

Throws:

JLIException

list

public java.util.List<NoteData> list(java.lang.String filename,
                            java.lang.String noteName,
                            java.util.List<java.lang.String> noteNames,
                            java.lang.String valuePattern,
                            boolean getExpandedValues,
                            boolean select,
                            java.lang.String sessionId)
                              throws JLIException

Specified by:

list in interface IJLNote

Throws:

JLIException

list

public java.util.List<NoteData> list(java.lang.String filename,
                            java.lang.String noteName,
                            java.util.List<java.lang.String> noteNames,
                            java.lang.String valuePattern,
                            boolean getExpandedValues,
                            boolean select,
                            AbstractJLISession sess)
                              throws JLIException

Specified by:

list in interface IJLNote

Throws:

JLIException

copy

public void copy(java.lang.String filename,
        java.lang.String noteName,
        java.lang.String toModel,
        java.lang.String toName,
        java.lang.String sessionId)
          throws JLIException

Specified by:

copy in interface IJLNote

Throws:

JLIException

copy

public void copy(java.lang.String filename,
        java.lang.String noteName,
        java.lang.String toModel,
        java.lang.String toName,
        AbstractJLISession sess)
          throws JLIException

Specified by:

copy in interface IJLNote

Throws:

JLIException

exists

public boolean exists(java.lang.String filename,
             java.lang.String noteName,
             java.util.List<java.lang.String> noteNames,
             java.lang.String sessionId)
               throws JLIException

Specified by:

exists in interface IJLNote

Throws:

JLIException

exists

public boolean exists(java.lang.String filename,
             java.lang.String noteName,
             java.util.List<java.lang.String> noteNames,
             AbstractJLISession sess)
               throws JLIException

Specified by:

exists in interface IJLNote

Throws:

JLIException

validateNoteName

public void validateNoteName(java.lang.String name)
                      throws JLIException

Checks whether a note name is valid. Throws an error if the name is not valid

Parameters:

name - The name to validate

Throws:

JLIException

getNoteText

public static java.lang.String getNoteText(CallNote note,
                           boolean expanded)
                                    throws com.ptc.cipjava.jxthrowable

Get the text of a model note. If the note contains multiple lines, the returned text will have a newline character at the end of each line.

Parameters:

note - The note object

expanded - Whether to expand parameter values

Returns:

The text of the note

Throws:

com.ptc.cipjava.jxthrowable

getNoteText

public static java.lang.String getNoteText(CallDetailNoteItem note,
                           boolean expanded)
                                    throws com.ptc.cipjava.jxthrowable

Get the text of a drawing note. If the note contains multiple lines, the returned text will have a newline character at the end of each line.

Parameters:

note - The note object

expanded - Whether to expand parameter values

Returns:

The text of the note

Throws:

com.ptc.cipjava.jxthrowable

copyOneNote

public void copyOneNote(CallDetailNoteItem note,
               CallModel m,
               java.lang.String toName)
                 throws JLIException,
                        com.ptc.cipjava.jxthrowable

Copy a drawing note to a note in another model/drawing or to another note in the same drawing

Parameters:

note - The drawing note to copy

m - The model/drawing containing the target note

toName - The name of the target note

Throws:

JLIException

com.ptc.cipjava.jxthrowable

getNoteInfo

public static boolean getNoteInfo(CallModel model,
                  CallModelItem item,
                  NoteData outvals,
                  boolean encoded,
                  boolean getExpandedValues)
                           throws com.ptc.cipjava.jxthrowable,
                                  JLIException

Get data about a model or drawing note

Parameters:

item - The model or drawing note object

outvals - The output object

encoded - Whether to return the text as a byte array

getExpandedValues - Whether to expand parameter values

Returns:

Whether the method was successful

Throws:

com.ptc.cipjava.jxthrowable

JLIException

getNoteInfo

public static boolean getNoteInfo(CallModel model,
                  CallModelItem item,
                  NoteData outvals,
                  boolean encoded,
                  java.util.regex.Pattern valuePtn,
                  boolean getExpandedValues)
                           throws com.ptc.cipjava.jxthrowable,
                                  JLIException

Get data about a model or drawing note

Parameters:

model - The model or drawing containing the note (used for drawing notes only)

item - The model or drawing note object

outvals - The output object

encoded - Whether to return the text as a byte array

valuePtn - Value pattern filter - if the value does not match the pattern, then the method will return false

getExpandedValues - Whether to expand parameter values

Returns:

Whether the function was successful

Throws:

com.ptc.cipjava.jxthrowable

JLIException